Notificaciones de API de CMS

En este tema, aprenderá acerca de CMS API las notificaciones. El CMS API proporciona notificaciones de cambios en los vídeos de su cuenta, ya sean realizados por un usuario de cuenta o el sistema de Video Cloud.

Resumen

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 debe apuntar a una aplicación capaz de manejar HTTP POST peticiones.

Autenticación

Al igual que todas las solicitudes a la API de CMS, las solicitudes para configurar o enumerar suscripciones de notificación deben autenticarse mediante 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 utiliza la interfaz de usuario de Studio para crear las credenciales).

Configuración

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

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

Las notificaciones se envían en formato JSON. He aquí un ejemplo:

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

Campos de notificación

Artículo	Descripción
`timestamp`	tiempo en el que se produjo el evento en Epoch milisegundos
`account_id`	el ID Video Cloud de cuenta
`event`	el tipo de evento - en la actualidad esto siempre será `video-change`
`video`	el ID de vídeo
`version`	la versión del vídeo - cada conjunto de eventos de cambio aumenta la versión del vídeo - por ejemplo, la creación de un nuevo conjunto de copias constituiría un conjunto de eventos de cambio

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

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

Fallos de notificación

El sistema de notificación trata cualquier 4xx o 5xx volver del servidor del cliente como una falla que se puede reintentar. 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 de su firewall, permitimos las IPs de AWS EE.UU. - East-1/Virginia. Esto está sujeto a cambios, por lo que todas las IP de AWS deben estar en la lista blanca. Consulte http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html para obtener más información.

Endpoint para suscripciones de notificación

        /accounts/{account_id}/subscriptions

Crear una nueva suscripción

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

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

Obtener una lista de sus suscripciones

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

Obtener o eliminar una única suscripción

Utilice el siguiente extremo para obtener o eliminar una única suscripción:

Endpoint

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

Una GET solicitud recuperará la suscripción. Una DELETE solicitud eliminará la suscripción. No puede actualizar una suscripción en este momento. Si quieres modificar una suscripción, tendrás que eliminarla y crear una nueva.

¿Qué desencadena notificaciones?

video-change se activan por cualquier cambio en los metadatos de vídeo. Esto incluye cualquier cambio en el video realizado en Studio o a través de un método de CMS API escritura. También hay eventos del sistema que desencadenarán video-change eventos.

Los cambios que desencadenarán un evento incluyen:

Se crea un vídeo
Inicio de la ingestión de archivos de vídeo o activos
Se ha completado la ingestión de archivos de vídeo o activos
Codificación de una nueva copia finaliza
Se crea una imagen de póster
Se crea una imagen en miniatura
Se elimina un vídeo
Los metadatos de vídeo se cambian (por el sistema o por un usuario)

Notas

La retranscodificación de un vídeo no desencadenará un video-change evento a menos que el conjunto de copias resultante sea diferente.

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

Lo que no desencadenará un video-change evento es un cambio en un activo de vídeo que no cambia los metadatos de vídeo. Por ejemplo, si reemplaza un archivo o una imagen de seguimiento de texto remoto, pero la URL grabada en los metadatos de vídeo sigue siendo la misma, no se producirá ningún video-change evento y no se enviará ninguna notificación.