CMS API Notificaciones

En este tema, aprenderás sobre CMS API notificaciones los CMS API proporciona notificaciones de cambios en los videos en su cuenta, ya sea que los haya realizado un usuario de la cuenta o Video Cloud sistema.

Resumen

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.

Autenticación

Como todas las solicitudes al CMS API, las solicitudes para configurar o enumerar las suscripciones de notificación se deben autenticar usando un Token de acceso. Las credenciales de cliente utilizadas para obtener el token de acceso deben tener permisos para video-cloud/notifications/all (CMS->Notifications si usas el UI de estudio para crear las credenciales.)

Preparar

Puede especificar hasta puntos finales 10 para recibir notificaciones haciendo una POST solicitud de https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions e incluyendo JSON en el cuerpo de la solicitud como este:

        {
        "endpoint":"http://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
        "events":["video-change"]
        }

Las notificaciones se envían en formato JSON. Aquí hay un ejemplo:

        {"timestamp":1423840514446,
        "account_id":"775205503001",
        "event":"video-change",
        "video":"4020894387001",
        "version":26}

Campos de notificación

Asunto	Descripción
`timestamp`	momento en que ocurrió el evento en Epoch milisegundos
`account_id`	el Video Cloud ID de la cuenta
`event`	el tipo de evento - actualmente esto siempre será `video-change`
`video`	la identificación del video
`version`	la versión del video: cada conjunto de eventos de cambio incrementa la versión de video; por ejemplo, la creación de un nuevo conjunto de representaciones constituiría un conjunto de eventos de cambio

Las solicitudes para crear una suscripción recibirán un HTTP 422 respuesta de error para las siguientes condiciones:

La endpoint or events campo falta en el cuerpo de la solicitud
La events el valor del campo no es una lista (matriz)
La suscripción definida ya existe
Ya tienes suscripciones 10 a este evento

Fallas de notificación

El sistema de notificación trata cualquier 4xx or 5xx regresar del servidor del cliente como una falla reintentable. 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 cortafuegos, permitimos las IP de AWS us-east-1 / Virginia. Esto está sujeto a cambios, por lo que todas las IP de AWS deben estar en la lista blanca. Ver http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html .

Endpoint para suscripciones de notificación

        /accounts/{account_id}/subscriptions

Crea una nueva suscripción

Para crear una nueva suscripción, envíe una POST solicitud con un cuerpo de solicitud que incluya el punto final al que desea que se envíen las notificaciones y video-change como el único elemento en una events formación:

        { "endpoint": "http://solutions.brightcove.com:9002", "events": [ "video-change" ] }

Obtenga una lista de sus suscripciones

Para obtener una lista de todas sus suscripciones, envíe un GET solicitud al punto final de suscripciones.

Obtener o eliminar una sola suscripción

Use el siguiente punto final para obtener o eliminar una suscripción individual:

Punto final

        /accounts/{account_id}/subscriptions/{subscription_id}

A GET solicitud recuperará la suscripción. UN DELETE solicitud eliminará la suscripción. No puede actualizar una suscripción en este momento. Si desea modificar una suscripción, deberá eliminarla y crear una nueva.

¿Qué desencadena las notificaciones?

video-change los eventos se desencadenan por cualquier cambio en los metadatos del video. Esto incluye cualquier cambio al video realizado en Studio o mediante un CMS API método de escritura. También hay eventos del sistema que activarán video-change eventos.

Los cambios que desencadenarán un evento incluyen:

Se crea un video
Ingestión de archivos de video o archivos activos
Se completa la ingestión de archivos de video o activos
Codificación de una nueva entrega termina
Se crea una imagen de póster
Se crea una imagen en miniatura
Un video es eliminado
Los metadatos de video son cambiados (por el sistema o un usuario)

Notas

Volver a codificar un video no activará un video-change evento a menos que el conjunto de representación resultante sea diferente.

Hay eventos del sistema que ocurren después de eliminar un video, por lo que recibirá notificaciones sobre un video después de eliminarlo.

Qué será no activar un video-change evento es un cambio a un activo de video que no cambia los metadatos de video. Por ejemplo, si reemplaza una imagen o archivo de seguimiento de texto remoto, pero la URL registrada en los metadatos de video permanece igual, no video-change evento ocurrirá, y no se enviará ninguna notificación.