OpenAPI 3.0.3v1.0.0

Confere API

API para consulta em tempo real de registros profissionais de saúde no Brasil (CRM, CRF, CFP, CRO, CFBM, CFMV, COREN) e estabelecimentos de saúde (CFM, ANVISA, CNES).

Autenticação

A API Confere usa autenticação JWT (Bearer Token).

Inclua o token JWT no cabeçalho da requisição:

Authorization: Bearer SEU_TOKEN_JWT

Dica de segurança: Nunca exponha seu token JWT em código client-side. Sempre faça as chamadas da API do lado do servidor.

Base URL

Todas as requisições devem ser feitas para uma das seguintes URLs.

http://localhost:1337

Servidor de Desenvolvimento

https://api.confere.com.br

Servidor de Produção

Profissionais de Saúde

POST/api/v1/crm

Consultar CRM (Médico)

Submete um job para consulta de registro CRM no Conselho Federal de Medicina.

Parâmetros

crmobrigatório

string

ufobrigatório

string

callbackUrl

string (uri)

Exemplos de Código

curl -X POST "http://localhost:1337/api/v1/jobs/crm" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{"crm": "123456", "uf": "SP"}'

POST/api/v1/crf

Consultar CRF (Farmacêutico)

Submete um job para consulta de registro CRF no Conselho Federal de Farmácia.

Parâmetros

crfobrigatório

string

ufobrigatório

string

callbackUrl

string (uri)

POST/api/v1/crn

Consultar CRN (Nutricionista)

Consulta nacional de registro no Conselho Federal de Nutricionistas. Informe nome ou número de registro.

Parâmetros

nome

string

crn

string

uf

string

POST/api/v1/cref

Consultar CREF (Educação Física)

Consulta nacional de registro no Conselho Federal de Educação Física. Informe nome ou número de registro.

Parâmetros

nome

string

cref

string

uf

string

POST/api/v1/crbio

Consultar CRBio (Biólogo)

Consulta nacional de registro no Conselho Federal de Biologia. Informe nome ou número de registro.

Parâmetros

nome

string

crbio

string

uf

string

POST/api/v1/cress

Consultar CRESS (Assistente Social)

Consulta nacional de registro no Conselho Federal de Serviço Social. Informe nome ou número de registro.

Parâmetros

nome

string

cress

string

uf

string

Estabelecimentos de Saúde

POST/api/v1/cnes

Consultar Estabelecimento CNES

Submete um job para consulta de estabelecimento no Cadastro Nacional de Estabelecimentos de Saúde (DATASUS).

Parâmetros

cnesobrigatório

string

callbackUrl

string (uri)

Gerenciamento de Jobs

GET/api/v1/jobs/{queue}/{jobId}

Obter status do job

Consulta o status e resultado de um job específico.

Parâmetros da URL

queueobrigatório

string

jobIdobrigatório

string

Exemplos de Resposta

{
  "id": "123",
  "status": "waiting",
  "progress": 0
}

Códigos de Resposta

Possíveis códigos de resposta da API

200

Sucesso

Requisição processada com sucesso

400

Bad Request

Parâmetros faltando ou incorretos

401

Não Autorizado

Token JWT inválido ou ausente

404

Não Encontrado

Job ou recurso não encontrado