Autenticação
Uma chave em todas as chamadas
Toda rota de dados exige o header x-api-key. A chave fica no .env do servidor — não é publicada aqui. As rotas /docs, /swagger e /health são abertas.
- Header
- x-api-key: SUA_CHAVE
- Sem a chave
401 · { "erro": "x-api-key ausente ou invalida" }
Endpoints
Consultas disponíveis
Todos são GET e devolvem JSON. Teste interativamente no Swagger UI.
GET/paciente/:cpfprincipal
Busca o beneficiário pelo CPF e devolve os dados dele — a consulta de elegibilidade. CPF com ou sem pontuação.
| Parâmetro | Onde | Obrigatório | Descrição |
|---|---|---|---|
| cpf | rota | sim | CPF do beneficiário (11 dígitos) |
| situacao | query | opcional | filtra pela situação |
# buscar paciente por CPF curl -H "x-api-key: SUA_CHAVE" \ "https://apasapi.healthplatformsuite.com.br/paciente/12345678909"
GET/elegibilidade/:cpfatalho
Apelido de /paciente/:cpf — mesmo resultado.
GET/beneficiario/:id
Dados completos pelo ID (vem no retorno da busca por CPF). ?incluir=cobertura,status traz blocos extras.
GET/carteira/:codigo
Busca pelo número da carteira, quando não há CPF.
GET/auth/checkdiagnóstico
Verifica se o proxy autentica na Solus. ok:true quando o token está válido.
GET/health
Sinal de vida. Sem chave, não chama a Solus.
Retornos
O que esperar
- 200
- Sucesso — dados do beneficiário (JSON da Solus)
- 400
- CPF inválido (≠ 11 dígitos)
- 401
- Chave do proxy errada ou token Solus expirado
- 502
- Falha ao falar com a Solus — ver campo
detalhe
Erros sempre em JSON: { "erro": "...", "detalhe": "...", "dica": "..." }.