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

    Resumen: CMS API

    En este tema, obtendrá una visión general de la API de CMS. El proporciona acceso de lectura no almacenado en caché a los datos.CMS API Esto es importante para los flujos de trabajo de publicación sensibles al tiempo, ya que se realizan cambios en los vídeos y las listas de reproducción utilizando y leer rápidamente los datos para comprobar que son correctos.CMS API

    Referencia de API

    Consulte también la Referencia de API.

    Información general

    URL base

    La URL base para el CMS API es:

            https://cms.api.brightcove.com/v1

    Ruta de la cuenta

    En todos los casos, se realizarán solicitudes para una Video Cloud Cuenta específica. Por lo tanto, siempre agregará el término seguido de su ID de cuenta a la URL base:accounts

            https://cms.api.brightcove.com/v1/accounts/{account_id}

    Autenticación

    La autenticación para solicitudes requiere Authorization header :

            Authorization: Bearer {access_token}

    El es un token de acceso OAuth2 temporal que debe obtenerse del servicio.access_tokenBrightcove OAuth Para obtener más información, consulte la descripción general de OAuth de Brightcove.

    La forma más sencilla de crear credenciales de cliente es a través de las páginas de administración de Brightcove Studio. Para obtener instrucciones detalladas, consulte Administración de credenciales de autenticación de API

    Operaciones

    Cuando solicite credenciales de cliente, deberá especificar el tipo de acceso a la cuenta u operaciones que desea. A continuación se muestra una lista de las operaciones admitidas actualmente para CMS API :

    • Datos de vídeo:

      video-cloud/video/read
      video-cloud/video/create
      video-cloud/video/update
      video-cloud/video/delete
      o
      video-cloud/video/all
      video-cloud/video/assets/delete (Solo es necesario si desea eliminar los maestros digitales; tenga en cuenta que no puedo obtenga este permiso cuando cree credenciales en Studio. Debe realizarse a través de la API de OAuth o la aplicación de muestra creada por Brightcove Learning Services.)

    • Datos de la lista de reproducción:

      video-cloud/playlist/read
      video-cloud/playlist/create
      video-cloud/playlist/update
      video-cloud/playlist/delete
      o
      video-cloud/playlist/all

    • Notificaciones:

    Limitación de la tasa

    Esto CMS API proporciona acceso de lectura no almacenado en caché a los datos. Esto es importante para los flujos de trabajo de publicación sensibles al tiempo, ya que se realizan cambios en los vídeos y las listas de reproducción utilizando y leer rápidamente los datos para comprobar que son correctos.CMS API

    El no CMS API es adecuado para el uso en tiempo de ejecución a gran escala (como el acceso a vídeos en una página web pública de alto tráfico). Para aplicaciones de alto tráfico, debe utilizar una interfaz almacenada en caché como: la Galería Playback API , los reproductores o los SDK nativos.

    Para garantizar el rendimiento del Video Cloud sistema, no se permiten más de 20 llamadas simultáneas CMS API a la por cuenta. La frecuencia de acceso debe ser inferior a 10 solicitudes por segundo.

    Si varias aplicaciones se integrarán en CMS API para una cuenta, estas aplicaciones deben tener lógica de retroceso y reintentar para manejar instancias donde se alcanzan los límites de concurrencia o los límites de tasa.

    Si se excede el límite de tasa o concurrencia, se devolverá un 429 - TOO_MANY_REQUESTS error.

    Conflictos de identificadores

    Para asegurar la singularidad de los identificadores de referencia, el identificador bloquea el id durante un máximo de 3 minutos después de cualquier operación en el vídeo al que está asignado.CMS API Esto puede provocar que se devuelvan 409 errores cuando intenta reintentar una solicitud que falla demasiado rápido o cuando intenta reutilizar un identificador de referencia demasiado pronto después de eliminar el vídeo al que se asignó anteriormente. Consulte la Referencia del mensaje de error para obtener más detalles.

    Límite de activos de vídeo

    Hay un límite de 1.000 activos por vídeo. Entre los activos se incluyen copias, pistas de audio, pistas de texto e imágenes, así como el maestro digital. Las representaciones y las imágenes rara vez suman más de 10-15 activos, por lo que incluso si tuviera pistas de audio y pistas de texto separadas para 150 idiomas diferentes, todavía tendría menos de 350 activos.

    Notas sobre el uso

    Métodos

    Actualmente, la API admite los siguientes tipos de solicitud:

    • GET
    • POST
    • PATCH
    • PUT
    • DELETE

    Parámetros

    Tenga en cuenta que todos los parámetros son opcionales. Excepto donde se indique, se aplican a GET solicitudes de vídeos y listas de reproducción.

    Parámetros de Solicitud
    Parámetros Descripción
    q Cadena de consulta para búsquedas: consulte Sintaxis de búsqueda para obtener más información
    limit Número de vídeos a devolver - debe ser un número entero entre 1 y 100. Predeterminado: 20
    offset Número de vídeos que se deben omitir (para resultados de paginación). Debe ser un entero positivo. Predeterminado: 0
    sort Cadena que especifica el campo por el que se va a ordenar. Comience con - ordenar descendente. Si q se proporciona un valor para, entonces la ordenación predeterminada es por «score» (relevancia de los resultados de búsqueda para la consulta original). Si no q se proporciona ningún valor para, entonces la ordenación predeterminada es updated_at descendente. Los siguientes campos son válidos para ordenar: name , reference_id , created_at , published_at , updated_at , schedule_starts_at , schedule_ends_at , state , plays_total y plays_trailing_week

    Brightcove CMS API ofrece una forma programática de buscar vídeos en su Video Cloud biblioteca.

    Para realizar búsquedas básicas y complejas en sus datos de vídeo, utilizará el parámetro:q

            https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q={search terms}

    Para obtener más información sobre cómo buscar vídeos, consulte el documento Buscar vídeos .

    Para las listas de reproducción, los valores admitidos para la cadena de búsqueda son más limitados. Actualmente puede buscar por type , name , description y reference_id. Aquí hay algunos ejemplos de búsquedas válidas:

    • q=type:EXPLICIT
    • q=type:ACTIVATED_OLDEST_TO_NEWEST
    • q=type:ALPHABETICAL
    • q=bears+otters ( nombre, descripción o identificación de referencia deben contener «osos» o «nutrias»)
    • q=%2Bname:bears+type:EXPLICIT ( el nombre debe contener «osos»)

    Consulta Buscar listas de reproducción para obtener más detalles.

    Resultados de paginación

    Utilice el limit parámetro para especificar cuántos elementos desea devolver en una solicitud, hasta 100. A continuación, puede utilizar el offset parámetro para realizar una página a través de conjuntos de resultados más grandes que el limit. El es el número de elementos que se deben omitir.offset

    Por ejemplo, la siguiente búsqueda devuelve vídeos 51-75 del conjunto total de resultados, suponiendo que el conjunto de resultados total tenga al menos 75 vídeos:

            /videos?q=updated_at:2014-01-01..2014-06-30&limit=25&offset=50

    los limit y offset Los parámetros se pueden usar tanto para videos como para listas de reproducción.

    Práctica recomendada de paginación

    Debido a que puede haber operaciones de modificación simultáneas en curso con la API de CMS, se recomienda seguir estos pasos al realizar la búsqueda a través del conjunto de resultados:

    1. Realice una count solicitud para obtener el número total de vídeos en su conjunto de resultados.
            /accounts/578380111111/counts/videos?q=tags:nature
    2. Utilizar el limit y offset parámetros para devolver grupos de datos de su conjunto de resultados.
            /accounts/578380111111/videos?q=tags:nature&limit=20&offset=50
    3. Tenga en cuenta que algunas páginas pueden tener menos de 20 vídeos. Sabrá que ha llegado al final del conjunto de resultados cuando haya solicitado tantos vídeos como en la primera count solicitud.

    Para resumir, siga recuperando páginas hasta que obtenga un recuento de vídeo igual a la count solicitud original, ya que este número debe errar en el lado de la sobreestimación. Pregunte por:

          count / page-size + 1 page

    Clasificación de los resultados de vídeo

    Utilice el parámetro sort=field_name para especificar cómo se deben ordenar los resultados; puede ordenar tanto video como listas de reproducción. Puede ordenar en los siguientes campos de vídeo: [1-1]

    • name
    • reference_id
    • created_at
    • published_at
    • updated_at
    • schedule_starts_at ( nota: este es el campo de ordenación - el campo de búsqueda es schedule.starts_at )
    • schedule_ends_at ( nota: este es el campo de ordenación - el campo de búsqueda es schedule.ends_at )
    • state
    • plays_total [ 1-2]
    • plays_trailing_week [ 1-2]

    Notas

    • [ 1-1] Si no proporciona un valor de clasificación para una llamada de búsqueda por vídeo, los resultados se ordenarán por relevancia. Si no proporciona un valor de ordenación para una llamada de vídeo, los resultados se ordenarán de forma descendente.GETupdated_at
    • [ 1-2] Puede ordenar por plays_total o plays_trailing_week , pero estos campos no están incluidos en los resultados

    Ordenar los resultados de la lista de reproducción

    Puede ordenar las listas de reproducción en los siguientes campos:

    • name
    • updated_at ( predeterminado)

    Todos los vídeos y conjuntos de datos de gran tamaño

    Si estás recuperando todos los vídeos de tu cuenta, o un gran número de vídeos, hay algunas cosas que debes tener en cuenta:

    1. Puede que tenga la tentación de usar el más grande permitido (100), pero es mejor recuperar videos en lotes de 25 o menos para minimizar la posibilidad de que las solicitudes API agoten el tiempo de esperalimit
    2. A medida que está paginando a través de conjuntos de datos grandes, es posible que los datos de vídeo se actualicen durante la operación, lo que podría hacer que los elementos cambien en las respuestas:
      • Es posible que veas un elemento repetido en páginas sucesivas.
      • Es posible que se pierda un elemento, ya que se ha desplazado a un conjunto de respuestas anterior

      Para tener en cuenta la primera posibilidad, su aplicación debe desduplicar la lista completa de elementos después de que haya terminado de recuperar vídeos. Para manejar la segunda posibilidad, debe comparar el número total de elementos recuperados (después de desduplicar) con el número que estaba esperando, y luego volver a ejecutar las solicitudes, ordenando los resultados por last_modified_date (descendente); no debería necesitar recuperar más de un lote para recoger los artículos perdidos.

    3. Puede disminuir la probabilidad de que se produzcan escenarios en el elemento anterior ordenando los resultados devueltos correctamente. La clasificación predeterminada por relevancia para las búsquedas se basa en un algoritmo complejo que busca combinaciones de palabras clave, etiquetas y valores de campo personalizados. Si está buscando vídeos basados en varias palabras clave, etiquetas o campos personalizados, ordenar por relevancia es exactamente lo que desea. Sin embargo, si solo está tratando de recuperar todos o un conjunto grande de sus vídeos, establecer el sort parámetro explícitamente le dará más control sobre el orden de los elementos devueltos.

    Operaciones de vídeo

    Las operaciones de vídeo incluyen:

    • Obtener un recuento de vídeos o resultados de búsqueda
    • Obtener todos los vídeos
    • Obtener uno o más vídeos por id o id de referencia
    • Crear, recuperar, actualizar y eliminar vídeos
    • Búsqueda de vídeos
    • Obtener fuentes de vídeo, imágenes e información maestra digital
    • Obtener las listas de reproducción a las que pertenece un vídeo
    • Quitar el vídeo de todas las listas de reproducción

    Los detalles de las operaciones de vídeo se pueden encontrar en la API Reference.

    Operaciones de lista de reproducción

    Las operaciones de lista de reproducción incluyen:

    • Obtener un recuento de listas de reproducción
    • Obtener todas las listas de reproducción
    • Crear, actualizar y eliminar listas de reproducción
    • Obtener un recuento de vídeos en una lista de reproducción
    • Obtener los vídeos en una lista de reproducción

    Los detalles de las operaciones de la lista de reproducción se pueden encontrar en la API Reference.

    Activos

    Las operaciones de activos le permiten administrar activos, incluidas copias, manifiestos, imágenes y pistas de texto. Para ingerir activos, debe utilizar el Dynamic Ingest API. los POST y PATCH operaciones para el CMS API /assets se puede utilizar para agregar y actualizar activos remotos. CMS API Las operaciones GET funcionarán tanto para activos ingeridos como remotos.

    • Agregar, actualizar o eliminar copias
    • Agregar, actualizar o eliminar metadatos para el maestro digital
    • Agregar, actualizar o eliminar manifiestos para tipos de vídeo segmentados como HLS
    • Agregar, actualizar o quitar imágenes de póster y miniaturas
    • Agregar, actualizar o quitar pistas de texto WebVTT o subtítulos de DFXP

    Los detalles de las operaciones de activos se pueden encontrar en la Referencia de API.

    Operaciones personalizadas sobre el terreno

    Actualmente hay una operación de campo personalizada:

    • Obtener todos los campos personalizados para una cuenta

    Los detalles de las operaciones de campo personalizadas se pueden encontrar en la Referencia de API.

    Operaciones de carpeta

    Las operaciones de carpeta le permiten:

    • Obtener una lista de carpetas
    • Crear, actualizar y eliminar carpetas
    • Obtener una lista de vídeos en una carpeta
    • Agregar un vídeo a una carpeta
    • Quitar un vídeo de una carpeta

    Los detalles de las operaciones de la carpeta se pueden encontrar en la Referencia de API.

    Notificaciones

    Puede recibir notificaciones cuando se produzcan video_change eventos en la biblioteca de vídeos. Las notificaciones se enviarán a la URL que especifique, que debería apuntar a una aplicación capaz de gestionar HTTP POST solicitudes.

    Fallos de notificación

    El sistema de notificación trata cualquier devolución 4xx o 5xx del servidor del cliente como un error recuperable. Las devoluciones de llamada fallidas se volverán a intentar hasta 20 veces, con un retraso que aumenta exponencialmente entre las devoluciones de llamada posteriores. Los primeros reintentos se producirán a los minutos del intento inicial de devolución de llamada. Si la devolución de llamada continúa fallando, y llegamos hasta el reintento 20, el retraso de reintento será de unos días.

    Firewalls

    En caso de que su organización tenga una política estricta con respecto a las fuentes de tráfico entrante a través del firewall, permitimos todas las IP de la región este de AWS. Esto está sujeto a cambios, por lo que todas las IP de AWS deben estar en la lista blanca. Consulte https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html para obtener más información.

    Operaciones de notificación

    Las operaciones actualmente disponibles para las notificaciones son:

    • Crear suscripciones
    • Obtener una o todas las suscripciones
    • Eliminar una suscripción

    Los detalles de las operaciones de notificación se pueden encontrar en la Referencia de API.


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