Resumen
Los archivos asociados con el sistema de entrega se administran a través de las API REST y, opcionalmente, a través de Git. Estos archivos se envían a players.brightcove.net ya sea a través de una llamada a la API o un "git push".
Si no ha pasado por el Paso a paso: API del sistema de entrega , es muy recomendable que empieces por ahí. Obtendrá la configuración de seguridad, aprenderá algunos de los conceptos básicos del sistema y luego estará listo para profundizar más aquí.
También vea el Referencia de API.
API de 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 enumerar sus repositorios. También puede utilizar llamadas a la API REST para manipular archivos en repositorios.
Puede usar 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:
- nombre: El nombre del repositorio. Este es el mismo nombre que se encuentra en las URL de la API REST.
- public_url: La URL base donde se pueden ver los archivos de repositorio.
La Paso a paso: Sistema de entrega proporciona una guía práctica sobre el uso de las API del sistema de entrega.
Autenticación
Puedes autorizarte a ti mismo usando Tokens de acceso de OAuth o mediante la autenticación básica con su nombre de usuario y contraseña de Brightcove. Los tokens de acceso estándar de OAuth 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.
Usaremos la autenticación básica en el Paso a paso ejemplos. Si desea utilizar tokens de acceso en su lugar, cambie:
--user $EMAIL
a:
--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, incluidas las llamadas de API existentes con errores ortográficos, obtendrá un código de estado 404 y un mensaje útil sobre lo que pudo haber hecho mal.
- Si su llamada no puede ser autenticada o autorizada, recibirá un código de estado 403. Intente repasar la guía de 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álidosACCESS_TOKEN_ERROR: el token de acceso proporcionado no era válidoINVALID_API_CALL: la llamada a la API no se formateó correctamenteNOT_FOUND: la llamada a la API no apuntaba a un recurso conocido o no estaba formateada correctamenteNO_PUT_CONTENTS: Se debe usar un formulario de varias partes con una clave de contenido para PONER un archivo de repositorioCREATE_REPO_ERROR: se produjo un error al crear un repositorioGET_REPO_ERROR: se produjo un error al obtener un repositorioGET_REPOS_ERROR: se produjo un error al obtener todos los repositoriosUNCAUGHT_ERROR: un error no detectado hizo que las cosas fallaranUNKNOWN_ERROR: ha ocurrido un error que no tiene un código de error asociado