API Notificações

• Detecção de problemas em tempo real – receba notificações instantâneas em caso de falha nas entregas de ativos ou alteração nos status das ofertas e resolva os problemas imediatamente, em vez de descobri-los horas ou dias depois em verificações manuais.
• Redução de despesas gerais da API – elimine a necessidade de consultar continuamente as APIs de status, reduzindo os custos de infraestrutura e o volume de chamadas da API enquanto mantém as informações atualizadas.
• Integração automatizada do fluxo de trabalho – conecte as notificações diretamente aos seus sistemas (serviços da AWS ou webhooks) para acionar respostas automatizadas, criação de tíquetes ou alertas de fluxos de trabalho sem intervenção manual.
• Cobertura abrangente de eventos – monitore o status de entregas de ativos e a disponibilidade de ofertas em todos os seus títulos e territórios a partir de um único sistema de notificação.

Para começar a usar as notificações, são necessárias três etapas:

1. Registre um alvo: Configure onde você deseja receber notificações. Você pode escolher entre os serviços da AWS (SQS, SNS, EventBridge) ou webhooks HTTPS.
2. Crie assinaturas: Mapeie os eventos que deseja monitorar de acordo com seus alvos registrados. Cada assinatura abrange um tópico (AssetStatus ou OfferStatus), mas você pode assinar vários tipos de eventos dentro desse tópico.
3. Receba notificações: Uma vez configurado, você receberá notificações automaticamente da ocorrência dos eventos em tempo real.

Esta seção fornece especificações técnicas para que os desenvolvedores consigam integrar a API Notificações de parceiros em seus sistemas. Use essa referência para entender o formato da solicitação, a estrutura de resposta e os tipos de dados retornados pela API.

URL base
Todas as solicitações de API são feitas na seguinte URL base. Inclua o caminho do endpoint relevante a essa URL ao fazer solicitações.

Um alvo é o destino em que você deseja receber notificações – pode ser um serviço da AWS (SQS, SNS ou EventBridge) ou um endpoint de webhook HTTPS. Você deve registrar pelo menos um alvo antes de criar assinaturas.

Registrar alvo

POST

Crie um novo alvo onde você receberá notificações de eventos.

Corpo da solicitação:

Resposta:

Listar todos os alvos

Use esse endpoint para recuperar a lista completa dos alvos de notificação registrados da sua organização. Essa lista pode ser útil para auditar sua configuração atual ou identificar IDs de alvos a serem usados ao criar ou atualizar assinaturas.

GET

Recupere todos os alvos registrados da sua organização.

Obtenha um alvo específico

GET

Recupere dados de um alvo específico.

Atualizar alvo

PUT

Atualize a configuração de um alvo existente.

Excluir alvo

DELETE

Remova um alvo de sua configuração.

Uma assinatura mapeia um ou mais eventos para um alvo registrado, determinando quais notificações você receberá e onde serão entregues. Cada assinatura tem como escopo um único tópico, mas você pode criar várias assinaturas para cobrir todos os eventos relevantes ao seu fluxo de trabalho.

Criar assinatura

POST

Crie uma assinatura para mapear eventos para seus alvos.

Corpo da solicitação:

Resposta:

Listar todas as assinaturas

GET

Recupere todas as assinaturas da sua organização.

Atualizar assinatura

PUT

Atualize a configuração de uma assinatura existente.

Excluir assinatura

DELETE

Remova uma assinatura de sua configuração.

Os tópicos agrupam eventos relacionados. Ao criar uma assinatura, você seleciona um tópico e especifica os eventos dentro desse tópico que deseja monitorar. Cada tópico é mapeado para uma área específica de rastreamento de status do conteúdo.

• LiveStatusUpdated – quando o status atual muda
• OfferStatusUpdated – quando o status da oferta muda (em breve)
• AssetStatusUpdated – quando o status do ativo muda (em breve)

Os tipos de alvo definem como o Prime Video enviará notificações aos seus sistemas. Você pode escolher entre serviços gerenciados pela AWS para entrega confiável e escalável ou configurar um webhook HTTPS para receber notificações diretamente em seu próprio endpoint.

Alvos AWS (SQS, SNS, EventBridge) – Campos obrigatórios:

• destino – ARN de recurso da AWS
• assumeRoleArn – função IAM de entrega
• externalId – identificador de segurança (opcional, mas recomendado)

Exemplo de SQS:

Exemplo de SNS:

Exemplo de EventBridge:

Alvos de webhook – token transmissor:

Alvos de webhook – chave da API:

Alvos de webhook – HMAC (recomendado):

Os webhooks recebem solicitações HTTP POST com a seguinte carga útil:

Cabeçalhos de autenticação:

• HMAC: Assinatura X: {signature}
• Chave da API: Chave da API X:{key}
• Transmissor: Autorização: Transmissor {token}

Quando uma solicitação não pode ser concluída, a API retorna uma resposta de erro estruturada para ajudá-lo a identificar e resolver o problema. A resposta inclui um código de erro e uma mensagem legível para o usuário descrevendo o problema.

Códigos de erro comuns:

• BAD_REQUEST – Parâmetros de solicitação inválidos
• UNAUTHORIZED – Falha na autenticação
• NOT_FOUND – Recurso não encontrado
• CONFLICT – O recurso já existe

Se estiver usando um serviço da AWS (SQS, SNS ou EventBridge) como alvo de notificação, configure uma função IAM de entrega para conceder permissão ao Prime Video para entregar notificações aos seus recursos da AWS. Siga as etapas abaixo para configurar a função IAM e as políticas de permissão necessárias antes de registrar seu alvo.

Pré-requisitos

• Recurso de destino da AWS (fila SQS, tópico SNS ou barramento EventBridge)
• Função IAM de entrega com políticas de confiança e permissão

Configuração de função IAM

1. Criar função: Console da AWS → IAM → Funções → Criar função → Política de confiança personalizada

2. Política de confiança

3. Política de permissão (escolha uma das seguintes)

SQS:

SNS:

EventBridge:

As seções a seguir fornecem respostas para perguntas comuns sobre como trabalhar com a API Notificações.