Características: Delivery System API

Resumen

Los archivos asociados con el sistema de entrega se administran a través de API REST y, opcionalmente, a través de Git. Estos archivos se entregan a players.brightcove.net ya sea a través de una llamada API o un "git push".

Si no has pasado por el Paso a paso: Delivery System API, es muy recomendable que comiences allí. Obtendrá la configuración de seguridad, aprenderá algunos de los conceptos básicos del sistema y luego estará listo para profundizar más aquí.

Ver también el Referencia de la API.

API REST del sistema de entrega

Las API del sistema de entrega se centran en repositorios, también conocidos como repositorios. Puede gestionar repos a través de un grupo de API REST que le permiten agregar, obtener y enumerar sus repositorios. También puede usar llamadas REST API para manipular archivos en repositorios.

Puede usar el curl de la herramienta de línea de comandos para usar las API REST. Las API REST devuelven respuestas en formato JSON que contienen la siguiente información sobre el éxito:

• nombre: el nombre del repositorio. Esto es lo mismo que el nombre que se encuentra en las URL de la API REST.
• public_url: la URL base donde se pueden ver los archivos de repositorio.

El Paso a paso: Sistema de entrega proporciona una guía práctica para usar el Delivery System APIs.

Autenticación

Puedes autorizarte a ti mismo usando cualquiera Tokens de acceso OAuth o mediante la autenticación básica con su nombre de usuario y contraseña de Brightcove. Los tokens de acceso OAuth estándar deben usarse para cualquier uso programático de las API, pero la ruta de autenticación básica es mucho más fácil para el uso de la línea de comandos y para comenzar.

Utilizaremos la Autenticación Básica en el Paso a paso ejemplos. Si desea utilizar tokens de acceso, cambie:

    --user $EMAIL

hasta:

    --header "Authorization: Bearer $ACCESS_TOKEN"

Respuestas de error API

Hay una serie de respuestas de error posibles que pueden devolverse en formato JSON cuando hay un problema con una llamada a la API REST:

• Si intentas llamar a una API que no existe, incluidas las llamadas a API existentes que no se escriben correctamente, obtendrás un código de estado de 404 y un mensaje útil sobre lo que pudiste haber hecho mal.
• Si su llamada no puede ser autenticada o autorizada, obtendrá un código de estado 403. Intente repasar la guía OAuth nuevamente para asegurarse de tener un token de acceso válido.
• Si intenta utilizar un método que no sea GET o PUT, la respuesta contendrá un código de estado 405.
• Si hay un problema con el procesamiento de su solicitud, obtendrá un código de estado 500 y una respuesta de error estándar de Brightcove.

La respuesta de error estándar de Brightcove mencionada anteriormente es una respuesta JSON que contiene el código de error y las propiedades del mensaje. El código de error será uno de los siguientes:

• INVALID_LOGIN_CREDENTIALS: el nombre de usuario y la contraseña proporcionados al usar la Autenticación básica no eran válidos
• ACCESS_TOKEN_ERROR: el token de acceso dado no era válido
• INVALID_API_CALL: la llamada API no se formateó correctamente
• NOT_FOUND: la llamada API no apuntaba a un recurso conocido o no estaba formateada correctamente
• NO_PUT_CONTENTS: Se debe usar un formulario de varias partes con una clave de contenido para PONER un archivo repo
• CREATE_REPO_ERROR: se produjo un error al crear un repositorio
• GET_REPO_ERROR: se produjo un error al obtener un repositorio
• GET_REPOS_ERROR: se produjo un error al obtener todos los repos
• UNCAUGHT_ERROR: un error no detectado hizo que las cosas fallaran
• UNKNOWN_ERROR: ha ocurrido un error que no tiene un código de error asociado

Limitaciones