Mecanismo de Notificação via API

O ANBIMA Feed possui recursos que permitem que os assinantes sejam acionados com notificações em algumas situações específicas. Por exemplo, exemplo quando existirem novas informações disponíveis, ou quando houver atraso para a disponibilização de determinadas informações. 

Para que este mecanismo funcione corretamente, é necessário que o assinante exponha uma API RESTFul para que o ANBIMA Feed possa fazer os respectivos acionamentos. A API deverá ser implementada de acordo com a especificação abaixo:

Método: POST

URI: definida pelo assinante e informada à ANBIMA para cadastro (ex. https://endpoint-cliente.com/recurso-cliente/)

Body:

{
  "id_notificacao_cliente": "string",
  "tipo_evento": "string",
  "data_envio": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "data_referencia": "string"
  "url_api_feed": "string",
}

Autenticação

É necessário que o tipo de autenticação seja a “Basic Authentication”, conforme especificado em: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization.

Campos da API

Tipos de Evento

NOVO Dados disponibilizados para o Pacote/Item e Data de Referência informados

ATUALIZACAO Dados corrigidos para o Pacote/Item e Data de Referência informados. Os dados que haviam sido armazenados anteriormente para este Pacote/Item e Data de Referência devem ser excluídos e substituídos pelos disponibilizados após a notificação deste tipo.

ATRASO Os dados de Pacote/Item e Data de Referência informados estão em atraso na sua geração.

URLs de Referência

Quando o ANBIMA Feed envia uma notificação, ele já possui novos dados para divulgar. Assim, logo após receber uma mensagem de notificação, seu sistema já poderá requisitar estes dados, invocando uma de nossas APIs. Utilize a informação contida no campo url_api_feed para invocar a API correta. Os parâmetros de “data” ou “mês e ano” já vem preenchidos.

O quadro abaixo resume quais APIs devem ser chamadas para solicitar a atualização de dados para cada API do ANBIMA Feed:

Códigos de Erro

Códigos de Sucesso