Paper Contacter le support | état du système L'état du système

Pas à pas: Delivery System API

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

Vue d'ensemble

Voici les étapes que vous allez effectuer:

  • Créer un repo en utilisant le Delivery System API
  • Créer un dossier local pour le stockage de fichiers
  • Créez un plugin et copiez-le dans le repo
  • Modifier le player utiliser le nouveau plugin
  • Modifiez le plugin et observez le player utilise le plugin modifié

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

Pré-requis

Pour commencer ces instructions pas à pas, il est supposé que vous avez terminé la Pas à pas: Player des programmes. En complétant 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 dépôt

Vous allez maintenant utiliser le Delivery System API pour créer un dépôt et copier des fichiers dans ce dépôt. Une fois le référentiel créé, vous pouvez également utiliser l'API pour répertorier les référentiels, afficher les détails d'un référentiel, supprimer les référentiels, etc., mais dans de nombreux workflows, cela n'est pas nécessaire.

Dans une déclaration curl pour créer le nouveau repo, vous utiliserez un HTTP PUT méthode et inclure 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 du repo. La réponse montrera: le nom et l'URL publique du repo.

  • Nom: Nom du dépôt
  • 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 le stockage des fichiers associés à votre Brightcove Player. Dans un emplacement de votre choix, créez le dossier, puis déplacez-vous (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 repo. Utilisez le même plugin de l'étape par étape: Player Gestion, sauf changer 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 par étape: Player Management, 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 du 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 semblable à celle-ci:

    {
      "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 voir le fichier en parcourant le public_url renvoyé de la copie du fichier.

Utiliser un nouveau plugin

Dans l'étape par étape: Player La direction vous a utilisé une instruction curl pour dire au player l'emplacement du code JavaScript du plugin, ainsi que l'emplacement CSS et le nom du plugin. Vous ferez de même la même chose, sauf que cette fois le chemin vers le plugin utilisera le nouveau chemin trouvé dans la réponse de la copie de fichier (montré à 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 retour preview_url parcourir le player et vous verrez le nouveau texte du plugin affiché. Si vous le souhaitez, vous pouvez également publier le player et faire publier player URL.

Alter plugin

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

Ouvrez le first-plugin.js fichier et mettre à jour le texte à lire Nouveau texte!

    overlay.innerHTML = "NEWer TEXT!";

Encore une fois, copiez 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

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 parcourir à 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 ensuite publier votre player.


Dernière mise à jour de la page le 12 juin 2020