assistance Contacter le support | Étatétat du système du système
Contenu de la page

    É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.

    Présentation

    Voici les étapes que vous allez effectuer :

    • Créer un repo à l'aide de l'API Delivery System
    • Créer un dossier local pour le stockage de fichiers
    • Créez un plugin et copiez-le dans le repo
    • Modifier le lecteur pour utiliser le nouveau plugin
    • Modifiez le plugin et observez que le lecteur utilise le plugin modifié

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

    Conditions préalables

    Pour démarrer ces instructions étape par étape, il est supposé que vous avez terminé l' étape par étape : Gestion des joueurs. En terminant cette activité, vous avez défini les variables d'environnement suivantes dans votre système de ligne de commande :

    • $ACCOUNT_ID
    • $EMAIL
    • $PLAYER_ID

    Créer un repo

    Vous allez maintenant utiliser l'API Delivery System pour créer un repo et copier des fichiers dans ce repo. Une fois le repo créé, vous pouvez également utiliser l'API pour lister les repos, afficher les détails d'un repo, supprimer des repos, etc., mais dans de nombreux workflows ce n'est pas nécessaire.

    Dans une instruction curl pour créer le nouveau repo, vous utiliserez une PUT méthode HTTP et inclurez le nom du nouveau repo dans l'URL. Exécutez cette instruction curl pour créer un repo 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 de repo. La réponse affichera : le nom et l'URL publique du repo.

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

    Créer un dossier

    Ensuite, vous devez créer un dossier localement sur votre ordinateur pour stocker les 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

    Maintenant, vous allez créer un plugin dans votre dossier à copier dans le repo. Utilisez le même plugin de l'étape par étape : Gestion du joueur, sauf modifier le texte affiché. Créez le fichier, collez le texte d'en bas dans le fichier, puis enregistrez-le. Utilisez le même nom de fichier que celui utilisé dans l'étape é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 plugin nouvellement créé dans le repo. 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 similaire à ce qui suit :

        {
          "name": "first-plugin.js",
          "public_url": "http://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 http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js

    Vous pouvez également afficher le fichier en parcourant le public_url renvoyé à partir de la copie du fichier.

    Utiliser le nouveau plugin

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

        curl \
          --header "Content-Type: application/json" \
          --user $EMAIL \
          --request PATCH \
          --data '{
            "scripts": [
              "http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js"
            ],
            "stylesheets": [
              "http://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

    Utilisez le retourné 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ée.

    Modifier le plugin

    L'une des forces de l'utilisation du nouveau lecteur Brightcove est la facilité de mise à jour des joueurs en faisant un seul changement à un plugin, et tous les joueurs utilisant ce plugin seront mis à jour. Dans ce point dans les étapes, vous allez faire un petit changement au plugin et le voir en cours d'utilisation sans apporter de modifications au lecteur lui-même.

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

        overlay.innerHTML = "NEWer TEXT!";

    Copiez à nouveau le fichier dans le repo.

        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

    Parcourez la même chose 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 vider le cache du navigateur pour voir le texte mis à jour.

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