API de notificaciones

Detección de problemas en tiempo real: reciba notificaciones instantáneas cuando las entregas de activos fallen o cambien los estados activos, lo que le permitirá abordar los problemas de inmediato en lugar de detectarlos horas o días después mediante comprobaciones manuales.

Reducción de la sobrecarga de las API: elimine la necesidad de realizar sondeos continuos sobre el estado de las API, lo que reducirá los costes de infraestructura y el volumen de llamadas a las API y, al mismo tiempo, mantendrá la información actualizada.

Integración automatizada del flujo de trabajo: conecte las notificaciones directamente a sus sistemas existentes (servicios o webhooks de AWS) para activar respuestas automatizadas, la creación de tickets o los flujos de trabajo de alertas sin intervención manual.

Cobertura integral de eventos: supervise tanto el estado de entrega como el estado de los activos en todos sus títulos y territorios desde un único sistema de notificaciones.

Para
empezar a usar las notificaciones hay que seguir tres pasos:

1. Registrar un objetivo: configura el lugar donde quieres recibir las notificaciones. Puede elegir entre los servicios de AWS (SQS, SNS, EventBridge) o los webhooks de HTTPS.
2. Crear suscripciones: asigne los eventos que desea monitorear a sus objetivos registrados. Cada suscripción cubre un tema (AssetStatus u OfferStatus), pero puedes suscribirte a varios tipos de eventos dentro de ese tema.
3. Recibir notificaciones: una vez configurado, recibirás automáticamente notificaciones a medida que se produzcan los eventos en tiempo real.

Los temas agrupan los eventos relacionados. Al crear una suscripción, se selecciona un tema y se especifican los eventos de ese tema que se desean supervisar.

Tema actualizado de LiveStatus:

Te avisa cuando el estado de emisión de un título cambia en la tienda Prime Video, es decir, cuando un título se publica o no.
¿Qué desencadena esta notificación? El estado de un título, activo o no publicado, cambia en la tienda. Usa la URL de llamada de la carga útil para recuperar todos los detalles del estado de la oferta a través de la API de estado de la oferta.

Carga útil:

Tema actualizado sobre el estado de los activos
:
Le notifica una vez que un activo alcanza un resultado de entrega final. Se envía una notificación cuando el estado de un activo pasa a ser:

• Cumplido: el activo se entregó correctamente, o
• Falló: el activo no se pudo entregar o necesita atención.

¿Qué desencadena esta notificación? Un cambio en el estado de entrega de un activo (por ejemplo, vídeo, audio, subtítulos o material gráfico). Utilice la URL de llamada para recuperar el estado completo de la entrega del activo, incluida la información detallada sobre el error, cuando proceda.

Casos de uso:

• Detecte los fallos de entrega en tiempo real y active flujos de trabajo automatizados para volver a realizar la entrega
• Confirme que el procesamiento de activos se ha realizado correctamente sin sondear la API de Estado de activos
• Intégrelo con los sistemas internos de emisión de entradas para una resolución inmediata de los problemas

Carga útil:

En esta sección se proporcionan especificaciones técnicas para que los desarrolladores integren la API de notificaciones para socios en sus sistemas. Utilice esta referencia para comprender el formato de la solicitud, la estructura de respuesta y los tipos de datos que devuelve la API.

URL base
Todas las solicitudes de API se realizan a la siguiente URL base. Añada la ruta de punto final correspondiente a esta URL al realizar solicitudes.

Administración de objetivos
Un destino es el destino en el que desea recibir las notificaciones; puede ser un servicio de AWS (SQS, SNS o EventBridge) o un punto de enlace webhook HTTPS. Debe registrar al menos un destino antes de crear suscripciones.

Registre Target

Crear un nuevo objetivo de notificaciones en el que recibirás las notificaciones de eventos.

Cuerpo de la solicitud:

Respuesta:

Listar todos los destinos
Utilice este punto final para recuperar una lista completa de los destinos de notificación registrados para su organización. Esto resulta útil para auditar la configuración actual o identificar los ID de destino que se utilizarán al crear o actualizar las suscripciones.

Recupera todos los objetivos registrados de tu organización.

Obtenga un objetivo específico

Recupera los detalles de un objetivo específico.

Actualiza Target

Actualice una configuración de destino existente.

Eliminar destino

Elimine un objetivo de la configuración.

Administración de suscripciones
Una suscripción asigna uno o más eventos a un objetivo registrado y determina qué notificaciones recibe y dónde se envían. Cada suscripción tiene un único tema, pero puedes crear varias suscripciones para cubrir todos los eventos relevantes para tu flujo de trabajo.

Crear suscripción

Crear una suscripción para asignar eventos a tus objetivos.

Cuerpo de la solicitud:

Respuesta:

Listar todas las suscripciones

Recupere todas las suscripciones de su organización.

Actualice la suscripción

Actualice una configuración de suscripción existente.

Eliminar la suscripción

Elimine una suscripción de la configuración.

Los tipos de objetivos definen la forma en que Prime Video envía las notificaciones a tus sistemas. Puede elegir entre los servicios gestionados por AWS para una entrega fiable y escalable, o configurar un webhook HTTPS para recibir las notificaciones directamente en su propio punto final.

Objetivos de AWS (SQS, SNS, EventBridge)

Campos obligatorios:

• destino: ARN del recurso de AWS
• AssumeroLearn: función de IAM para la entrega
• ExternalID: identificador de seguridad (opcional pero recomendado)

Ejemplo de SQS:

Ejemplo de SNS:

Ejemplo de EventBridge:

Símbolo portador:

Clave de API:

HMAC (recomendado):

Estructura de carga útil Todas
las cargas útiles de notificación siguen una estructura coherente:

Los webhooks reciben solicitudes HTTP POST con la siguiente carga útil:

Encabezados de autenticación:

• HMAC: Firma X: {firma} Firma X: {firma}
• Clave de API: clave de API X: {clave} clave de API X: {clave}
• Portador: Portador {token} Autorización: Portador {token}

Cuando no se puede completar una solicitud, la API devuelve una respuesta de error estructurada para ayudarte a identificar y resolver el problema. La respuesta incluye un código de error y un mensaje legible para las personas que describe el problema.

Códigos de error comunes:

• BAD_REQUEST: parámetros de solicitud no válidos
• NO AUTORIZADO: error de autenticación
• NOT_FOUND — Recurso no encontrado
• CONFLICTO: el recurso ya existe

Si utiliza un servicio de AWS (SQS, SNS o EventBridge) como destino de notificaciones, debe configurar un rol de entrega de IAM para conceder permiso a Prime Video para enviar notificaciones a sus recursos de AWS. Siga los pasos que se indican a continuación para configurar el rol de IAM y las políticas de permisos necesarios antes de registrar su destino.

Requisitos previos

• Recurso de destino de AWS (SQS Queue, SNS Topic o EventBridge Bus)
• Función de entrega de IAM con políticas de confianza y permisos

2. Política de confianza

3. Política de permisos (elija una):

SQS:

SNS:

EventBridge: