soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Características: CMS API

    En este tema, obtendrá una visión general de la CMS API. El CMS API proporciona acceso de lectura sin caché a los datos. Esto es importante para los flujos de trabajo de publicación sensibles al tiempo porque realiza cambios en los videos y listas de reproducción con el CMS API y lea rápidamente los datos para verificar que es correcto.

    Referencia de API

    Ver también el Referencia de la API.

    Información General

    URL base

    La URL base para el CMS API es:

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

    Ruta de cuenta

    En todos los casos, las solicitudes se realizarán para un Video Cloud Cuenta. Entonces, siempre agregarás el término accounts seguido de su identificación de cuenta a la URL base:

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

    Autenticación

    La autenticación para las solicitudes requiere una Authorization header :

            Authorization: Bearer {access_token}

    La access_token es un token de acceso OAuth2 temporal que debe obtenerse desde Brightcove OAuth Servicio. Para más detalles, vea el Descripción general de Brightcove OAuth.

    La forma más fácil de crear credenciales de cliente es a través de las páginas de administración de Brightcove Studio. Para obtener instrucciones detalladas, consulte Administrar Credenciales de Autenticación API

    Operaciones

    Cuando solicite credenciales del cliente, deberá especificar el tipo de acceso a la cuenta u operaciones que desea. La siguiente es una lista de las operaciones actualmente compatibles para el CMS API :

    • Datos de video:

      video-cloud/video/read
      video-cloud/video/create
      video-cloud/video/update
      video-cloud/video/delete
      or
      video-cloud/video/all
      video-cloud/video/assets/delete (Solo es necesario si desea eliminar maestros digitales; tenga en cuenta que no obtenga este permiso cuando cree credenciales en Studio. Debe hacerse a través de OAuth API o el 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
      or
      video-cloud/playlist/all

    • Notificaciones:

    Límite de velocidad

    La página CMS API proporciona acceso de lectura sin caché a los datos. Esto es importante para los flujos de trabajo de publicación sensibles al tiempo porque realiza cambios en los videos y listas de reproducción con el CMS API y lea rápidamente los datos para verificar que es correcto.

    La CMS API no es apropiado para el uso en tiempo de ejecución a gran escala (como el acceso a videos en una página web pública de alto tráfico). Para aplicaciones de alto tráfico, debe usar una interfaz en caché como: Playback API , Gallery, Players, o los SDK nativos.

    Para garantizar el rendimiento del Video Cloud sistema, no más de 20 llamadas simultáneas al CMS API están permitidos por cuenta. La frecuencia de acceso debe ser menor que las solicitudes 10 por segundo.

    Si se integrarán múltiples aplicaciones a la CMS API para una cuenta, estas aplicaciones deberían tener una lógica de rellamada y de reintentos para manejar instancias donde se alcanzan límites de concurrencia o límites de velocidad.

    Si se excede el límite de velocidad o concurrencia, se 429 - TOO_MANY_REQUESTS error será devuelto

    Conflictos de ID de referencia

    Para asegurar la unicidad de los identificadores de referencia, CMS API bloquea la identificación por hasta 3 minutos después de cualquier operación en el video al que está asignado. Esto puede dar como resultado que se devuelvan errores 409 cuando intenta reintentar una solicitud que falla demasiado rápido, o cuando intenta reutilizar una identificación de referencia demasiado pronto después de eliminar el video al que fue asignado previamente. Ver el Referencia de mensaje de error para más detalles.

    Límite de contenido de video

    Existe un límite de activos 1,000 por video. Los activos incluyen interpretaciones, pistas de audio, pistas de texto e imágenes, así como el maestro digital. Las repeticiones y las imágenes rara vez suman más que los recursos de 10-15, por lo que incluso si tuviera pistas de audio y pistas de texto separadas para diferentes idiomas de 150, aún tendría menos recursos de 350.

    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 opcional. Excepto donde se indique, se aplican a GET solicitudes de videos y listas de reproducción.

    GET Parámetros de solicitud
    Parámetro Descripción
    q Cadena de consulta para búsquedas - ver Sintaxis de búsqueda para más información
    limit Número de videos a devolver: debe ser un número entero entre 1 y 100. Predeterminado: 20
    offset Cantidad de videos para omitir (para resultados de búsqueda). Debe ser un entero positivo. Predeterminado: 0
    sort Una cadena que especifica el campo para ordenar. Empezar con - ordenar descendente Si un valor para q se proporciona, entonces el tipo predeterminado es por "puntuación" (relevancia de los resultados de búsqueda a la consulta original). Si no hay valor para q se proporciona, entonces el tipo predeterminado es updated_at descendiendo 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's CMS API proporciona una forma programática para buscar videos en su Video Cloud biblioteca.

    Para realizar búsquedas básicas y complejas en sus datos de video, usará q parámetro:

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

    Para detalles sobre cómo buscar videos, vea el Videos de la búsqueda documento.

    Para 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 ID de referencia debe contener "osos" o "nutrias")
    • q=%2Bname:bears+type:EXPLICIT (el nombre debe contener "osos")

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

    Resultados de paginación

    Utilice la limit parámetro para especificar cuántos elementos desea devolver en una solicitud, hasta 100. Puede usar el offset parámetro a la página a través de conjuntos de resultados que son más grandes que el limit. El offset es la cantidad de elementos para saltear.

    Por ejemplo, la siguiente búsqueda devuelve los videos 51-75 del conjunto de resultados total, suponiendo que el conjunto total de resultados tiene al menos videos 75:

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

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

    Mejor práctica de búsqueda

    Debido a que puede haber operaciones de modificación concurrentes en curso con el CMS API, se recomienda seguir estos pasos al realizar una paginación a través de su conjunto de resultados:

    1. Haz una count solicite obtener la cantidad total de videos en su conjunto de resultados.
            /accounts/578380111111/counts/videos?q=tags:nature
    2. Utilice la 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 videos 20. Sabrá que ha llegado al final del conjunto de resultados cuando haya solicitado tantos videos como en el primero count solicitud.

    En resumen, sigue recuperando páginas hasta que obtengas un conteo de video igual al original count solicitud, ya que este número debe errar por el lado de la sobreestimación. Pregunta por:

          count / page-size + 1 page

    Ordenar resultados de video

    Usa el parámetro sort=field_name para especificar cómo deben ordenarse los resultados: puede ordenar tanto el video como las listas de reproducción. Puede ordenar en los siguientes campos de video: [1 1-]

    • name
    • reference_id
    • created_at
    • published_at
    • updated_at
    • schedule_starts_at (nota: este es el sort campo - el campo de búsqueda es schedule.starts_at )
    • schedule_ends_at (nota: este es el sort campo - 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 de video, los resultados se ordenarán por relevancia. Si no proporciona un valor de clasificación para un GET llamada de videos, los resultados serán ordenados por updated_at descendiendo
    • [1 2-] Puedes ordenar plays_total or plays_trailing_week, pero estos campos no están incluidos en los resultados

    Ordenar los resultados de la lista de reproducción

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

    • name
    • updated_at (Por defecto)

    Todos los videos y grandes conjuntos de datos

    Si está recuperando todos los videos en su cuenta, o una gran cantidad de videos, hay algunas cosas que debe tener en cuenta:

    1. Puede estar tentado de usar el mayor permitido limit (100), pero es mejor recuperar videos en lotes de 25 o menos para minimizar la posibilidad de que las API agote el tiempo de espera
    2. A medida que navega por grandes conjuntos de datos, es posible que los datos de video se actualicen durante la operación, lo que podría provocar que los elementos cambien en las respuestas:
      • Es posible que vea un elemento repetido en páginas sucesivas
      • Se puede perder un elemento, ya que se ha desplazado a un conjunto de respuesta anterior

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

    3. Puede disminuir la probabilidad de los escenarios en el elemento anterior clasificando los resultados devueltos de manera apropiada. La clasificación predeterminada por relevancia para búsquedas se basa en un algoritmo complejo que busca combinaciones de palabras clave, etiquetas y valores de campo personalizados. Si está buscando videos basados ​​en varias palabras clave, etiquetas y / o campos personalizados, ordenar por relevancia es exactamente lo que quiere. Sin embargo, si solo está tratando de recuperar todo o un gran conjunto de sus videos, establezca el sort el parámetro explícitamente le dará más control sobre el orden de los artículos devueltos.

    Operaciones de video

    Las operaciones de video incluyen:

    • Reciba un recuento de videos o resultados de búsqueda
    • Obtener todos los videos
    • Obtenga uno o más videos por ID o ID de referencia
    • Crear, recuperar, actualizar y eliminar videos
    • Buscar videos
    • Obtenga fuentes de video, imágenes y la información maestra digital
    • Obtener las listas de reproducción a las que pertenece un video
    • Eliminar el video de todas las listas de reproducción

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

    Operaciones de lista de reproducción

    Las operaciones de lista de reproducción incluyen:

    • Obtén un recuento de listas de reproducción
    • Obtener todas las listas de reproducción
    • Crea, actualiza y elimina listas de reproducción
    • Obtén un recuento de videos en una lista de reproducción
    • Obtener los videos en una lista de reproducción

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

    Archivos

    Las operaciones de activos le permiten administrar activos que incluyen entregas, manifiestos, imágenes y pistas de texto. Para ingerir activos, debe usar el Dynamic Ingest API. El POST y PATCH operaciones para el CMS API /assets se puede usar para agregar y actualizar activos remotos. CMS API Las operaciones GET funcionarán para en activos ingeridos y remotos.

    • Agregar, actualizar o eliminar interpretaciones
    • Agregue, actualice o elimine un metadato para el maestro digital
    • Agregue, actualice o elimine manifiestos para tipos de video segmentados como HLS
    • Agregue, actualice o elimine pósteres e imágenes en miniatura
    • Agregar, actualizar o eliminar pistas de texto WebVTT o subtítulos DFXP

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

    Operaciones de campo personalizadas

    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 Referencia de la API.

    Operaciones de carpeta

    Las operaciones de carpeta le permiten:

    • Obtener una lista de carpetas
    • Crear, actualizar y eliminar carpetas
    • Obtener una lista de videos en una carpeta
    • Agregar un video a una carpeta
    • Eliminar un video de una carpeta

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

    Notificaciones

    Puedes recibir notificaciones cuando video_change los eventos ocurren en tu biblioteca de videos Las notificaciones se enviarán a la URL que especifique, que debe apuntar a una aplicación capaz de manejar HTTP POST peticiones.

    Fallas de notificación

    El sistema de notificación trata cualquier devolución de 4xx o 5xx del servidor del cliente como una falla restituible. Las devoluciones de llamadas fallidas se volverán a intentar hasta 20 veces, con un retraso exponencialmente creciente entre las devoluciones de llamada posteriores. Los primeros reintentos se realizarán minutos después del intento de devolución de llamada inicial. Si la devolución de llamada continúa fallando, y llegamos hasta el reintento de 20th, la demora de reintento será de unos pocos días.

    Los cortafuegos

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

    Operaciones de notificación

    Las operaciones actualmente disponibles para 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 Referencia de la API.


    Página actualizada por última vez el 12 jun 2020