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:

{
  "tipo_evento": "string",
  "nome_pacote": "string",
  "nome_item": "string",
  "descricao": "string",
  "data_referencia": "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

Nome CampoDescrição
id_notificacao_clienteIdentificador da mensagem enviada ao assinante
tipo_eventoTipo do evento de notificação (ex. NOVO, ATRASO, ATUALIZACAO). Esta informação refere-se ao tipo do evento que gerou a notificação, por ex: novos dados de Pacote/Item disponibilizados pela API
data_envioData em que a mensagem foi enviada
nome_pacoteO nome do pacote para o qual foi gerada a notificação
nome_itemO nome do item do pacote para o qual foi gerada a notificação
descricaoTexto descritivo da notificação
data_referenciaA data de referência dos dados disponibilizados
url_api_feedURL de Referência para que os dados possam ser consultados no Feed

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:

Nome PacoteNome ItemDescriçãoSufixo Path API
INDICESCARTEIRA_TEORICA_IDACarteira Teórica IDAindices/carteira-teorica-ida
INDICESRESULTADOS_IDAResultados IDAindices/resultados-ida-fechado
INDICESCARTEIRA_TEORICA_IHFACarteira Teórica IHFAindices/carteira-teorica-ihfa
INDICESRESULTADOS_IHFAResultados IHFAindices/resultados-ihfa-fechado
INDICESRESULTADOS_IDKAResultados IDKAindices/resultados-idka
INDICESRESULTADOS_IMAResultados IMAindices/resultados-ima
INDICESCARTEIRA_TEORICA_IMACarteira Teórica IMAindices/carteira-teorica-ima
INDICESRESULTADO_INTRADIARIOResultado Intradiárioindices/resultados-intradiarios-ima
INDICES_MAISCARTEIRA_TEORICA_IDACarteira Teórica IDAindices-mais/carteira-teorica-ida
INDICES_MAISCARTEIRA_TEORICA_IHFACarteira Teórica IHFAindices-mais/carteira-teorica-ihfa
INDICES_MAISRESULTADOS_IDKAResultados IDKAindices-mais/resultados-idka
INDICES_MAISCARTEIRA_TEORICA_IMACarteira Teórica IMAindices-mais/carteira-teorica-ima
INDICES_MAISRESULTADO_INTRADIARIOResultado Intradiárioindices-mais/resultados-intradiarios-ima
INDICES_MAISPU_INTRADIARIOPU Intradiárioindices-mais/pu-intradiario
INDICES_MAISRESULTADOS_COMPONENTE_IHFAResultados e Componentes IHFAindices-mais/resultados-ihfa
INDICES_MAISRESULTADOS_COMPONENTE_IMAResultados e Componentes IMAindices-mais/resultados-ima
INDICES_MAISRESULTADOS_COMPONENTE_IDAResultados e Componentes IDAindices-mais/resultados-ida
TITULOS_PUBLICOSMERCADO_SECUNDARIO_TPFMercado Secundáriotitulos-publicos/mercado-secundario-TPF
TITULOS_PUBLICOSVNAVNAtitulos-publicos/vna
TITULOS_PUBLICOSCURVAS_JUROSCurvas de Jurostitulos-publicos/curvas-juros
TITULOS_PUBLICOSDIFUSAO_TAXASDifusão de Taxastitulos-publicos/difusao-taxas
TITULOS_PUBLICOSCURVA_INTRADIARIACurva Intradiáriatitulos-publicos/curva-intradiaria
TITULOS_PUBLICOSPROJECAO_IPCA_IGPMProjeções IGPM e IPCAtitulos-publicos/projecoes
TITULOS_PUBLICOSESTIMATIVA_SELICEstimativa Selictitulos-publicos/estimativa-selic
TITULOS_PUBLICOSPU_INTRADIARIOPU Intradiáriotitulos-publicos/pu-intradiario
DEBENTURESCURVAS_CREDITOCurvas de Créditodebentures/curvas-credito
DEBENTURESPROJECAO_IPCA_IGPMProjeções IGPM e IPCAdebentures/projecoes
DEBENTURESMERCADO_SECUNDARIO_DEBENTURESMercado Secundário Debdebentures/mercado-secundario
CRI_CRAPROJECAO_IPCA_IGPMProjeções IGPM e IPCAcri-cra/projecoes
CRI_CRAMERCADO_SECUNDARIO_CRICRAMercado Secundário CRI-CRAcri-cra/mercado-secundario
IMA_ETFPREVIA_CARTEIRA_TEORICA_IMAPrévia Carteira Teóricaima-etf/previa-carteira-teorica
IMA_ETFCARTEIRA_TEORICA_IMACarteira Teórica IMAima-etf/carteira-teorica
IMA_ETFRESULTADO_DIARIOResultado Diárioima-etf/resultado-diario
IMA_ETFCOMPOSICAO_DIARIAComposição Diáriaima-etf/composicao-diaria
IMA_ETFPU_INTRADIARIOPU Intradiárioima-etf/pu-intradiario
IMA_ETFRESULTADO_INTRADIARIOResultado Intradiárioima-etf/resultado-intradiario
IMA_ETFNEGOCIOS_EXTRANegócios Extraima-etf/negocios-extra
FUNDOSFUNDOS_LISTA_COMPLETALista Completa de Fundosfundos
FUNDOSFUNDOS_DETALHESDetalhes do Fundofundos/{codigoFundo}
FUNDOSFUNDOS_NOTA_EXPLICATIVANotas Explicativas do Fundofundos/{codigoFundo}/notas-explicativas
FUNDOSFUNDOS_SERIE_HISTORICAFundos Série Históricafundos/{codigoFundo}/serie-historica

Códigos de Erro

Código HTTPDescrição
400Requisição malformada. Por favor, verifique a URI da requisição
401Requisição requer autenticação. Provavelmente o “código base64” enviado pela ANBIMA pode ter sido criado com credenciais inválidas, ou pode estar ausente no header da chamada.
405Método não permitido. O método da chamada deve ser POST, por favor, verificar
406Conteúdo ou Content-Type inválido. Por favor verificar o conteúdo enviado no Body da chamada (esperamos um json contendo os campos referentes à notificação)
5XXErro interno inesperado no servidor

Códigos de Sucesso

Código HTTPDescrição
200Notificação recebida com sucesso