API de FIDC

Informações gerais

A API de FIDC (Documento 3040) do ANBIMA Input é composta por APIs RESTful baseadas no protocolo HTTP, utilizadas para o envio sistêmico e o acompanhamento do Documento 3040 de Fundos de Investimento em Direitos Creditórios (FIDC) junto à ANBIMA.

Por meio dessa API, é possível abrir uma solicitação de envio, transmitir as partes do arquivo (via upload assinado em S3) e acompanhar ou cancelar o protocolo criado, de forma segura e padronizada.

Demonstração (Swagger)

A API de FIDC do ANBIMA Input foi desenvolvida utilizando OpenAPI Specification, permitindo que você, desenvolvedor, tenha maior flexibilidade para consultar a documentação técnica, entender os recursos disponíveis e realizar testes iniciais de integração. Por meio do Swagger, é possível visualizar os endpoints disponíveis para abertura de solicitação de envio, envio das partes do arquivo e acompanhamento de protocolos.

Vantagens do uso do Swagger:

• Try it out: permite a realização de testes iniciais diretamente em nossa plataforma.
• REST: padrão de fácil integração

Acesse já o Portal Swagger – ANBIMA Input – FIDC

Primeiros passos

Conheça nossos ambientes

As APIs do ANBIMA Input podem ser acessadas através de dois ambientes: Sandbox e Produção.

O ambiente de Sandbox pode ser utilizado para testes gerais do serviço, como validar o formato das requisições, consultar a estrutura das respostas e realizar testes iniciais de integração. Neste ambiente, os dados retornados poderão ser fixos e fictícios.

Já as informações oficiais e o processamento efetivo dos documentos estarão disponíveis apenas no ambiente de Produção.

Como realizar chamadas aos recursos de nossa API?

Na prática, uma chamada à API de FIDC considera sempre o modelo de URI abaixo:

https://[ambiente]/api/v1/[recurso]

sendo:

protocolo: https

ambiente: input-api.prd.anbima.com.br/external-gateway-service (Produção) ou input-api.hml.anbima.com.br/external-gateway-service (Sandbox)

versão: v1

recurso: fidc/3040 (abertura de solicitação e envio das partes) ou protocolos (acompanhamento e cancelamento)

Logo, a URI base a ser utilizada para envio do Documento 3040 de FIDC é:

https://[ambiente]/api/v1/fidc/3040

Já o acompanhamento e o cancelamento de protocolos são feitos por um recurso compartilhado entre os documentos do ANBIMA Input:

https://[ambiente]/api/v1/protocolos

A partir dessa estrutura, a API disponibiliza recursos para abertura de solicitação de envio, envio das partes do arquivo, listagem e consulta de protocolos e cancelamento de protocolos.

Exemplos de chamadas

Exemplo de URI para abrir uma solicitação de envio:

POST https://[ambiente]/api/v1/fidc/3040/solicitacao-envio

Exemplo de URI para solicitar o envio de uma parte do arquivo:

POST https://[ambiente]/api/v1/fidc/3040/solicitacao-envio/[numero_protocolo]/envio-parte

Exemplo de URI para listar protocolos:

GET https://[ambiente]/api/v1/protocolos

Exemplo de URI para consultar um protocolo específico:

GET https://[ambiente]/api/v1/protocolos/[numero_protocolo]

Exemplo de URI para cancelar um protocolo:

DELETE https://[ambiente]/api/v1/protocolos/[numero_protocolo]

Lembrando que os recursos desta API são privados e devem ser acessados através do padrão de autenticação OAuth2 (fluxo Client Credentials, máquina-a-máquina), com envio do token de acesso no formato Bearer Token. A autenticação é explicada em detalhes na seção Autenticação das APIs do ANBIMA Input.

Códigos de Erro

Código HTTP	Descrição
400	Requisição malformada. Verifique os campos obrigatórios (ex.: total de partes, data-base) e o conteúdo enviado no body.
401	Requisição não autenticada ou token de acesso inválido. Verifique as credenciais e o Bearer Token informado.
404	Protocolo não encontrado. Verifique se o número de protocolo informado está correto.
5XX	Erro interno inesperado no servidor.

Códigos de Sucesso

Código HTTP	Descrição
200	Consulta realizada com sucesso. Os dados solicitados (listagem ou detalhe de protocolo) são retornados no body da resposta.
201	Recurso criado com sucesso (abertura de solicitação de envio ou registro de envio de uma parte).
204	Protocolo cancelado com sucesso, sem conteúdo no corpo da resposta.