Étape par étape : API du système de livraison

Ce document fournit une introduction pratique à l'utilisation de l'API Delivery System pour créer un référentiel (repo), et dans le repo, vous enregistrez et mettez à jour un plugin.

Aperçu

Voici les étapes que vous effectuerez :

  • Créer un dépôt à l'aide de l'API du système de livraison
  • Créer un dossier local pour le stockage de fichiers
  • Créez un plugin et copiez-le dans le dépôt
  • Modifiez le lecteur pour utiliser le nouveau plugin
  • Modifiez le plugin et observez que le joueur utilise le plugin modifié

Remarque : Si vous êtes un utilisateur expérimenté de Git, vous verrez que certains des appels d'API exécutent des fonctionnalités équivalentes que vous pouvez également utiliser dans Git. En fait, certains des appels d'API de manipulation de fichiers exécutent simplement des commandes Git.

Conditions préalables

Pour commencer ces instructions étape par étape, il est supposé que vous avez terminé le Pas à pas: Gestion des joueurs. En complétant cette activité, vous avez défini les variables d'environnement suivantes dans votre système de ligne de commande :

  • {identifiant de compte}
  • $EMAIL
  • {player_id}

Créer un dépôt

Vous allez maintenant utiliser l'API du système de livraison pour créer un référentiel et copier des fichiers dans ce référentiel. Une fois le dépôt créé, vous pouvez également utiliser l'API pour répertorier les dépôts, afficher les détails d'un dépôt, supprimer les dépôts, etc., mais dans de nombreux flux de travail, cela n'est pas nécessaire.

Dans une instruction curl pour créer le nouveau référentiel, vous utiliserez un HTTP PUT méthode et incluez le nom du nouveau référentiel dans l'URL. Exécutez cette instruction curl pour créer un référentiel nommé firstRepo.

    curl \
      --user $EMAIL \
      --request PUT \
      https://repos.api.brightcove.com/v1/accounts/{account_id}/repos/firstRepo
    

Vous recevrez une réponse confirmant la création du dépôt. La réponse affichera : le nom et l'URL publique du dépôt.

  • name: Nom du dépôt
  • URL_publique : L'URL publique du dépôt
  • URL_repo : L'URL du référentiel
    {
      "name": "firstRepo",
      "public_url": "https://players.brightcove.net/1507807800001/firstRepo",
      "repo_url": "https://repos.api.brightcove.com/v1/accounts/1507807800001/repos/firstRepo"
    }

Créer le dossier

Ensuite, vous devez créer un dossier localement sur votre machine pour le stockage des fichiers associés à votre Brightcove Player. Dans un emplacement de votre choix créez le dossier puis déplacez (cd ) dans ce dossier.

    mkdir firstRepo
    cd firstRepo

Créer un plugin

Vous allez maintenant créer un plugin dans votre dossier à copier dans le référentiel. Utilisez le même plugin de l'étape par étape : Player Management, sauf modifier le texte affiché. Créez le fichier, collez le texte ci-dessous dans le fichier, puis enregistrez-le. Utilisez le même nom de fichier que celui utilisé dans l'étape par étape : Gestion des joueurs, first-plugin.js.

    videojs.registerPlugin('firstPlugin', function() {
      var player = this,
      overlay = document.createElement('p');
      overlay.className = 'vjs-overlay';
      overlay.innerHTML = "NEW TEXT!";
      player.el().appendChild(overlay);
    });

Vous allez maintenant copier le fichier de plug-in nouvellement créé dans le référentiel. Utilisez l'instruction cURL suivante pour effectuer cette tâche.

    curl \
      --user $EMAIL \
      --form contents=@first-plugin.js \
      --request PUT \
      https://repos.api.brightcove.com/v1/accounts/{account_id}/repos/firstRepo/files/first-plugin.js

Après la copie, vous devriez voir une confirmation semblable à la suivante :

    {
      "name": "first-plugin.js",
      "public_url": "https://players.brightcove.net/1507807800001/firstRepo/first-plugin.js"
    }

Vous pouvez confirmer que le fichier a été copié correctement en affichant son contenu à l'aide de l'instruction cURL suivante.

    curl https://players.brightcove.net/{account_id}/firstRepo/first-plugin.js

Vous pouvez également visualiser le fichier en parcourant le public_url renvoyé de la copie de fichier.

Utiliser un nouveau plugin

Au pas à pas : Player Management, vous avez utilisé une instruction curl pour indiquer au lecteur l'emplacement du code JavaScript du plug-in, ainsi que l'emplacement CSS et le nom du plug-in. Vous ferez la même chose, sauf que cette fois, le chemin d'accès au plugin utilisera le nouveau chemin trouvé dans la réponse de la copie du fichier (indiqué à la ligne 2 ci-dessus dans la réponse de copie). Exécutez l'instruction curl suivante pour pointer vers le nouvel emplacement du plug-in.

    curl \
      --header "Content-Type: application/json" \
      --user $EMAIL \
      --request PATCH \
      --data '{
        "scripts": [
          "https://players.brightcove.net/{account_id}/firstRepo/first-plugin.js"
        ],
        "stylesheets": [
          "https://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"
        ],
        "plugins": [{
          "name": "firstPlugin"
        }]
      }' \
      https://players.api.brightcove.com/v2/accounts/{account_id}/players/{player_id}/configuration

Utiliser le retour preview_url pour parcourir le lecteur et vous verrez le nouveau texte du plugin affiché. Si vous le souhaitez, vous pouvez également publier le lecteur et obtenir l'URL du lecteur publié.

Modifier le plug-in

L'un des points forts de l'utilisation du nouveau lecteur Brightcove est la facilité de mise à jour des lecteurs en apportant une seule modification à un plug-in, et tous les lecteurs utilisant ce plug-in seront mis à jour. À ce stade des étapes, vous apporterez une petite modification au plugin et le verrez en cours d'utilisation sans apporter de modifications au lecteur lui-même.

Ouvrez le first-plugin.js fichier et mettre à jour le texte à lire Texte plus récent !

    overlay.innerHTML = "NEWer TEXT!";

Copiez à nouveau le fichier dans le référentiel.

    curl \
      --user $EMAIL \
      --form contents=@first-plugin.js \
      --request PUT \
      https://repos.api.brightcove.com/v1/accounts/{account_id}/repos/firstRepo/files/first-plugin.js

Parcourir le même preview_url d'en haut à nouveau. Remarque : En raison de la mise en cache du navigateur, vous devrez peut-être fermer l'onglet du navigateur et naviguer à nouveau, ou même effacer le cache du navigateur pour voir le texte mis à jour.

Une fois que vous voyez la dernière version du plugin fonctionner, vous pouvez alors publier votre lecteur.