Autenticação
A API Confere usa autenticação JWT (Bearer Token).
Inclua o token JWT no cabeçalho da requisição:
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.
Servidor de Desenvolvimento
Servidor de Produção
Profissionais de Saúde
POST
/api/v1/jobs/crmConsultar CRM (Médico)
Submete um job para consulta de registro CRM no Conselho Federal de Medicina.
Parâmetros
crmobrigatóriostring
ufobrigatóriostring
callbackUrlstring (uri)
Exemplos de Código
POST
/api/v1/jobs/crfConsultar CRF (Farmacêutico)
Submete um job para consulta de registro CRF no Conselho Federal de Farmácia.
Parâmetros
crfobrigatóriostring
ufobrigatóriostring
callbackUrlstring (uri)
POST
/api/v1/jobs/cfpConsultar CFP (Psicólogo)
Submete um job para consulta de registro CFP no Conselho Federal de Psicologia.
Parâmetros
cpfstring
nomestring
registrostring
callbackUrlstring (uri)
POST
/api/v1/jobs/croConsultar CRO (Dentista)
Submete um job para consulta de registro CRO no Conselho Regional de Odontologia.
Parâmetros
croobrigatóriostring
ufobrigatóriostring
callbackUrlstring (uri)
POST
/api/v1/jobs/cfbmConsultar CFBM (Biomédico)
Submete um job para consulta de registro CFBM no Conselho Federal de Biomedicina.
Parâmetros
nomestring
registrostring
callbackUrlstring (uri)
POST
/api/v1/jobs/cfmvConsultar CFMV (Veterinário)
Submete um job para consulta de registro CFMV no Conselho Federal de Medicina Veterinária.
Parâmetros
queryobrigatóriostring
tipo_inscricaostring
ufstring
callbackUrlstring (uri)
POST
/api/v1/jobs/corenConsultar COREN (Enfermeiro)
Submete um job para consulta de registro COREN no Conselho Regional de Enfermagem.
Parâmetros
cpfstring
inscricaostring
nomestring
ufstringpadrão:
"SP"callbackUrlstring (uri)
Estabelecimentos de Saúde
POST
/api/v1/jobs/cfm-estabelecimentoConsultar Estabelecimento de Saúde (CFM)
Submete um job para consulta de estabelecimento de saúde no Conselho Federal de Medicina.
Parâmetros
cnpjobrigatóriostring
callbackUrlstring (uri)
POST
/api/v1/jobs/anvisaConsultar Empresa ANVISA
Submete um job para consulta de empresa farmacêutica na ANVISA.
Parâmetros
cnpjobrigatóriostring
callbackUrlstring (uri)
POST
/api/v1/jobs/cnesConsultar Estabelecimento CNES
Submete um job para consulta de estabelecimento no Cadastro Nacional de Estabelecimentos de Saúde (DATASUS).
Parâmetros
cnesobrigatóriostring
callbackUrlstring (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óriostring
jobIdobrigatóriostring
Exemplos de Resposta
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