soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Paso a paso: API del sistema de entrega

    Este documento proporciona una introducción práctica al uso de la API del sistema de entrega para crear un repositorio (repositorio), y en el repositorio guardará y actualizará un complemento.

    Resumen

    Estos son los pasos que realizará:

    • Crear un repositorio mediante la API del sistema de entrega
    • Crear una carpeta local para el almacenamiento de archivos
    • Cree un plugin y cópielo en el repositorio
    • Alterar el reproductor para utilizar el nuevo plugin
    • Alterar el plugin y observar que el jugador usa el plugin 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 API de manipulación de archivos simplemente realizan comandos de Git.

    Requisitos

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

    • $IDCUENTA_CUENTA
    • $CORREO ELECTRÓNICO
    • $PLAYER_ID

    Crear repositorio

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

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

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

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

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

    Crear carpeta

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

        mkdir firstRepo
        cd firstRepo

    Crear plugin

    Ahora creará un plugin en su carpeta para copiarlo en el repositorio. Utilice el mismo complemento del paso a paso: Administración de reproductores, 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 se utiliza en el paso a paso: Gestión de Jugadores, 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 de plugin recién creado en el repositorio. Utilice 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, debe 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 visualizando su contenido mediante la siguiente instrucción cURL.

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

    También puede ver el archivo explorando la copia public_url devuelta desde la copia del archivo.

    Usar nuevo plugin

    En el paso a paso: Administración del Reproductor utilizó una instrucción curl para decirle al jugador la ubicación del código JavaScript para el plugin, junto con la ubicación CSS y el nombre del complemento. Hará lo mismo otra vez, excepto que esta vez la ruta al plugin usará la nueva ruta encontrada en la respuesta de la copia del archivo (que se muestra en la línea 2 anterior en la respuesta de 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

    Utilice el devuelto preview_url para navegar por el reproductor y verá el nuevo texto del plugin mostrado. Si lo elige, también puede publicar el reproductor y obtener la URL del reproductor publicado.

    Alter plugin

    Uno de los puntos fuertes de utilizar el nuevo reproductor de Brightcove es la facilidad para actualizar a los jugadores haciendo un solo cambio en un plugin, y todos los jugadores que utilicen ese plugin se actualizarán. En este punto de los pasos se hará un pequeño cambio en el plugin y lo verá en uso sin hacer ningún cambio en el propio reproductor.

    ¡Abra el first-plugin.js archivo y actualice el texto para leer Texto más reciente!

        overlay.innerHTML = "NEWer TEXT!";

    Copie nuevamente el archivo en el 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

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

    Una vez que vea la última versión del plugin funcionando, puede publicar su reproductor.


    Última actualización de la página el 28-09-2020