API de Títulos Privados

Informações gerais

A API de Títulos Privados do ANBIMA Input é composta por APIs RESTFul baseadas no protocolo HTTP, utilizadas para o envio, consulta e acompanhamento de documentos relacionados a ativos de Títulos Privados junto à ANBIMA.

Por meio dessa API, é possível realizar o envio programático de documentos de Debêntures, Certificados de Recebíveis Imobiliários (CRIs), Certificados de Recebíveis do Agronegócio (CRAs), Notas Comerciais, Notas Promissórias, Certificados de Recebíveis (CR), Certificado de Direitos Creditórios do Agronegócio (CDCA), Certificado de Registro de Pessoa Física (CRPF) e Outros Títulos de Securitização (OTS), de forma segura e padronizada.

Demonstração (Swagger)

A API de Títulos Privados 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 envio e consulta de documentos 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 – Títulos Privados

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 Títulos Privados considera sempre o modelo de URI abaixo:

https://[ambiente]/api/v1/titulos-privados/[recursos]/[parâmetros]

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 base: titulos-privados

Logo, a URI base a ser utilizada para acesso aos recursos da API de Títulos Privados é:

https://[ambiente]/api/v1/titulos-privados

A partir dessa estrutura, a API disponibiliza recursos para listagem de Títulos Privados, envio de documentos, consulta de protocolos e reenvio de arquivos.

Exemplos de chamadas

Exemplo de URI para listar Títulos Privados elegíveis à sua organização:

GET https://[ambiente]/api/v1/titulos-privados

Exemplo de URI para envio de documentos:

POST https://[ambiente]/api/v1/titulos-privados/documentos

Exemplo de URI para consulta de protocolos:

GET https://[ambiente]/api/v1/titulos-privados/protocolos

Exemplo de URI para consultar um protocolo específico:

GET https://[ambiente]/api/v1/titulos-privados/protocolos/[protocolo]

Exemplo de URI para reenvio de arquivo associado a um protocolo existente:

PUT https://[ambiente]/api/v1/titulos-privados/protocolos/[protocolo]

Lembrando que os recursos desta API são privados e devem ser acessados através do padrão de autenticação OAuth2, com envio do token de acesso no formato Bearer Token. A autenticação é explicada em detalhes na seção Autenticação.

Códigos de Erro

Código HTTP	Descrição
400	Requisição malformada. Verifique a URI da requisição, os parâmetros informados 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.
403	Acesso não autorizado ao recurso solicitado.
404	Recurso não encontrado. Verifique se o endpoint ou protocolo informado está correto.
405	Método não permitido para o recurso solicitado.
406	Conteúdo ou Content-Type inválido. Verifique o formato enviado na requisição.
5XX	Erro interno inesperado no servidor.

Códigos de Sucesso

Código HTTP	Descrição
200	Consulta realizada com sucesso. Os dados solicitados são retornados no body da resposta.
202	Envio aceito para processamento. Um protocolo será criado para acompanhamento da solicitação.