Skip to content

Referência das APIs ​

A referência interativa traz, no formato OpenAPI, os endpoints, esquemas e exemplos das APIs reguladas que o Finnest Power implementa:

  • Open Finance Brasil: APIs de dados e de iniciação de pagamento do Open Finance Brasil.
  • Open Insurance Brasil: APIs do Open Insurance Brasil.
  • Dados abertos e diretório: APIs de dados abertos e a consulta pública de participantes.
  • APIs de aplicação (receptora OFB): as operações de /banking-receiver que o backend do participante chama com o token da própria aplicação.
  • APIs de aplicação (receptora OPIN): as operações de /insurance/open-insurance/v1/connections que o backend do participante chama, como receptora do Open Insurance, com o token da própria aplicação.

Cada documento regulado contém só as operações do catálogo regulatório vigente. O info.version de cada documento é a versão do serviço que o publica. A referência é de consulta: ela não chama nenhuma instalação da plataforma. Os documentos OpenAPI podem ser baixados na própria referência. Para saber quais APIs e versões a plataforma implementa, veja Cobertura regulatória.

APIs de aplicação ​

As APIs de receptora e de iniciadora do Open Finance, que o backend do participante chama com o token da própria aplicação, estão em Acesso por aplicação. O contrato da receptora está na referência interativa, como APIs de aplicação (receptora OFB), e o passo a passo até a primeira leitura de transações está em Primeiros passos.

O contrato da receptora do Open Insurance está na referência interativa, como APIs de aplicação (receptora OPIN). Ele cobre abrir a conexão com a transmissora, consultá-la, coletar os dados, ler segurados, apólices, prêmios, sinistros e planos de previdência, e revogar a conexão. O passo a passo, com a criação da aplicação e o endereço do token, está no Admin da instalação, em Developer › Primeiros passos da API.

Portal da sua instalação ​

Cada instalação pode publicar o próprio portal em docs.<domínio>. A referência desse portal também é só de consulta. O portal tem um painel de testes só para as APIs de dados abertos, que chama api.<domínio>/data-public, sem autenticação. As demais APIs você chama de um terminal ou da coleção Bruno. Para ativar o portal, veja Portal de API da instalação.

Finnest Power — plataforma Open Finance Brasil e Open Insurance Brasil. Contato: oi@finnest.com.br