Resumen: API del sistema de entrega

Resumen

Los archivos asociados con Delivery System 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, se recomienda encarecidamente que comience allí. Obtendrá configuración de seguridad, aprenderá algunos de los conceptos básicos del sistema y luego estará listo para sumergirse más aquí.

Consulte también la Referencia de API.

API REST del sistema de entrega

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

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

• name: El nombre del repositorio. Este es el mismo que el nombre encontrado en las URL de la API REST.
• public_url: La URL base donde se pueden ver los archivos de repositorio.

El paso a paso: Delivery System proporciona una guía práctica sobre el uso de las API del sistema de entrega.

Autenticación

Puede autorizarse utilizando tokens de acceso OAuth o mediante Autenticación básica utilizando su nombre de usuario y contraseña de Brightcove. Los tokens de acceso estándar de OAuth se deben utilizar 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 la introducción.

Usaremos Autenticación básica en los ejemplos paso a paso . Si desea usar tokens de acceso en su lugar, cambie:

    --user $EMAIL

por:

    --header "Authorization: Bearer $ACCESS_TOKEN"

Respuestas de error de API

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

• Si intenta llamar a una API que no existe, incluida la ortografía incorrecta de las llamadas API existentes, obtendrá un código de estado 404 y un mensaje útil sobre lo que puede haber hecho mal.
• Si su llamada no puede ser autenticada o autorizada, obtendrá un código de estado 403. Intente volver a consultar la guía de OAuth para asegurarse de que tiene un token de acceso válido.
• Si intenta utilizar un método distinto de GET o PUT, la respuesta contendrá un código de estado 405.
• Si hay algún 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 propiedades error_code y mensaje. El código de error será uno de los siguientes:

• INVALID_LOGIN_CREDENTIALS: el nombre de usuario y la contraseña dados cuando se utiliza la autenticación básica no eran válidos
• ACCESS_TOKEN_ERROR: el token de acceso proporcionado no era válido
• INVALID_API_CALL: la llamada a la API no se formateó correctamente
• NOT_FOUND: la llamada a la API no apuntaba a un recurso conocido o no se formateó correctamente
• NO_PUT_CONTENTS: Se debe usar un formulario de varias partes con una clave de contenido para PUT un archivo de repositorio
• 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 repositorios
• UNCAUGHT_ERROR: un error no detectado provocó que las cosas fallaran
• UNKNOWN_ERROR: se ha producido un error que no tiene un código de error asociado

Limitaciones