soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema

Paso a paso: Delivery System API

Este documento proporciona una introducción práctica sobre el uso de Delivery System API para crear un repositorio (repo), y en el repositorio guardará y actualizará un complemento.

Resumen

Estos son los pasos que realizará:

  • Crea un repositorio usando el Delivery System API
  • Crea una carpeta local para el almacenamiento de archivos
  • Cree un complemento y cópielo al repositorio
  • Alterar el player usar el nuevo complemento
  • Modifique el complemento y observe el player usa el complemento alterado

Nota: Si usted es un usuario experimentado de Git, verá que algunas de las llamadas API realizan una funcionalidad equivalente que también puede hacer en Git. De hecho, algunas de las llamadas de API de manipulación de archivos simplemente realizan comandos Git.

Requisitos previos

Para comenzar estas instrucciones paso a paso, se supone que ha completado el Paso a paso: Player Administración. Al completar dicha actividad, ha definido las siguientes variables de entorno en su sistema de línea de comandos:

  • $ ACCOUNT_ID
  • $ EMAIL
  • $PLAYER_ID

Crear un repo

Ahora usará el Delivery System API para crear un repositorio y copiar archivos a ese repositorio. Una vez creado el repositorio, también puede usar la API para enumerar repositorios, mostrar detalles de un repositorio, eliminar repositorios, etc., pero en muchos flujos de trabajo esto no es necesario.

En una declaración curl para crear el nuevo repositorio, utilizará un HTTP PUT método e incluir el nombre del nuevo repositorio en la URL. Ejecute esta instrucción curl para crear un repositorio llamado firstRepo.

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

Recibirás una respuesta confirmando la creación del repositorio. La respuesta mostrará: el nombre y la URL pública del repositorio.

  • nombre: nombre del repositorio
  • public_url: la URL pública al repositorio
  • repo_url: el repositorio URL
    {
      "name": "firstRepo",
      "public_url": "http://players.brightcove.net/1507807800001/firstRepo",
      "repo_url": "https://repos.api.brightcove.com/v1/accounts/1507807800001/repos/firstRepo"
    }

crear una carpeta

A continuación, debe crear una carpeta localmente en su máquina para almacenar los archivos asociados con su Brightcove Player. En una ubicación de su elección, cree la carpeta y luego mueva (cd) en esa carpeta.

    mkdir firstRepo
    cd firstRepo

Crear plugin

Ahora creará un complemento en su carpeta para copiarlo en el repositorio. Use el mismo complemento del paso a paso: Player Gestión, excepto cambiar el texto que se muestra. Cree el archivo, pegue el texto de abajo en el archivo y guárdelo. Utilice el mismo nombre de archivo que el utilizado paso a paso: Player Gestión, 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);
    });

Ahora copiará el archivo del complemento recién creado al repositorio. Use la siguiente instrucción cURL para realizar esta tarea.

    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

Después de la copia, debería ver una confirmación similar a la siguiente:

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

Puede confirmar que el archivo se copió correctamente al ver su contenido utilizando la siguiente instrucción cURL.

    curl http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js

También puede ver el archivo navegando por public_url devuelto de la copia del archivo.

Use un nuevo complemento

En el paso a paso: Player La gerencia usó una declaración curl para decirle al player la ubicación del código JavaScript para el complemento, junto con la ubicación CSS y el nombre del complemento. Hará lo mismo nuevamente, excepto que esta vez la ruta al complemento usará la nueva ruta que se encuentra en la respuesta de la copia del archivo (que se muestra en la línea 2 anterior en la respuesta de la copia). Ejecute la siguiente instrucción curl para apuntar a la nueva ubicación del complemento.

    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

Use el devuelto preview_url para navegar por el player y verá el nuevo texto del complemento que se muestra. Si elige, también puede publicar el player y obtener el publicado player URL.

Alterar plugin

Una de las fortalezas de usar el nuevo Brightcove player es la facilidad de actualización players haciendo un solo cambio a un complemento, y todos playerLos s que usan ese complemento se actualizarán. En este punto de los pasos, hará un pequeño cambio en el complemento y lo verá en uso sin realizar ningún cambio en el player misma.

Abra la first-plugin.js archiva y actualiza el texto para leer ¡Texto más nuevo!

    overlay.innerHTML = "NEWer TEXT!";

Nuevamente copie el archivo al repositorio.

    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

Navega por lo mismo preview_url desde arriba otra vez Nota: Debido al almacenamiento en caché del navegador, es posible que deba cerrar la pestaña del navegador y navegar de nuevo, o incluso borrar la caché del navegador para ver el texto actualizado.

Una vez que vea la última versión del complemento en funcionamiento, puede publicar su player.


Página actualizada por última vez el 12 jun 2020