Introdução

Este manual tem como objetivo orientar o uso da API do BRC, incluindo instruções sobre acesso ao Swagger, obtenção de token e exemplo de consulta aos endpoints disponíveis.

A API do BRConselhos (BRC) tem como finalidade disponibilizar informações de profissionais cadastrados, conforme critérios definidos por instituições autorizadas. Permite consultas com base em parâmetros personalizados, retornando dados cadastrais e complementares de acordo com as regras estabelecidas.

Contratação e Acesso

Para utilizar a API, é necessário contratá-la junto ao BRConselhos. Após a contratação, será disponibilizado um token de acesso inicial, que permitirá realizar chamadas autenticadas à API.

Acesso ao Swagger

Para acessar a documentação interativa da API, utilize o seguinte endereço:

http://<domínio-ou-ip>/brconselhos/api/swagger/index

Obtenção do Token de Acesso

Com o token de acesso inicial disponibilizado pelo BRC, siga os passos abaixo para gerar o token de autenticação e utilizá-lo nas requisições:

Abra o Postman ou outra ferramenta similar.
Crie uma nova requisição do tipo POST para o endpoint de autenticação.
Em seguida, no menu Authorization da requisição que deseja testar:
- Selecione o tipo Bearer Token.
- Cole o token gerado no campo indicado.
No menu Body, selecione a opção raw e o formato JSON, e informe os dados de login.
Clique em Send.
No retorno da requisição, copie o valor do token exibido no campo token da resposta JSON.

Exemplo de Consulta em um Endpoint

Para realizar uma consulta na API:

Localize o endpoint desejado, como /api/pessoa…
Cole no campo Token no menu Authorization o valor copiado anteriormente
Acesse o menu Body e insira os parâmetros necessários
Clique em ‘Send’.

Detalhamento dos Endpoints

Todos os endpoints seguem o padrão demonstrado no exemplo acima. O Swagger apresenta a documentação completa com todos os campos de entrada e saída, bem como as regras específicas para cada cenário de uso.