A documentação técnica das APIs está dividida em dois portais para sua consulta.

APIs Padrões OPIN

Para consultar a documentação técnica no padrão Swagger das APIs padrões especificadas pela estrutura do OPIN Brasil:

• Acesse a Área do Desenvolvedor OPIN;
• No menu lateral esquerdo selecione "Especificações de APIs";
  
• Selecione o agrupamento de APIs desejado. Por exemplo para consultar a API de dados de seguro Auto, selecione "Fase 2 - Dados relacionados à movimentações";
  
• Selecione o sub-grupo desejado. Seguindo o exemplo acima, selecione "API - Auto";
  
• Selecione a versão desejada;
• Por fim, selecione a opção "Informações Técnicas".

Nesta página será exibido a especificação técnica da API no padrão Swagger. Você poderá consultar os endpoints especificados, padrões de corpo das chamadas e respostas, códigos de erros e schema dos dados relacionados.

Para consultar o Schema dos dados transacionados:

• Selecione o endpoint desejado. Por exemplo para consultar os dados retornados de informações da apólice, selecione o endpoint que termina em "policy-info";

• Desça a tela até o exemplo de retorno de sucesso da chamada (código 200);

• Clique em "Schema";
  
• Aqui você poderá navegar pela estrutura da resposta, verificar a descrição de cada campo, se contém múltiplos valores, obrigatoriedade, entre outras informações:
  
  Os campos marcados com "*" são campos que obrigatoriamente serão retornados na resposta da transmissora

APIs Brick Insurance

Para consultar a documentação técnica das APIs exclusivas da plataforma Brick Insurance:

• Acesse o nosso Portal do Desenvolvedor
• Selecione o menu "API";
  
• No menu lateral esquerdo navegue até a API desejada. Por exemplo para consultar a documentação técnica da API de solicitação de consentimentos, navegue até "BRICK INSURANCE - RECEPTORA - COMPARTILHAMENTO DE DADOS V2" e selecione "Consentimento" e "Solicitação de Consentimento";
  
• Na tela exibida você poderá consultar todas as informações da especificação da API, incluindo os padrões de chamadas e respostas, códigos de erro, etc: