Cadastra um beneficiário em um plano de telemedicina e retorna o número do cartão (numeroCartao), que identifica o contrato nas demais operações.
POST /v1/TeleMedicina/Adesao
POST https://api.sauddy.com.br/v1/TeleMedicina/Adesao
Authorization: Bearer <token>
Content-Type: application/json
Use o caminho sem acento:
A rota também é publicada como /v1/TeleMedicina/Adesão, mas os clientes HTTP codificam o caractere ã na URL e a chamada pode retornar 404. Use sempre /v1/TeleMedicina/Adesao.
Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome | string | Sim | Nome completo do beneficiário. |
cpf | string | Sim | CPF do beneficiário, com ou sem máscara. Deve ter 11 dígitos. |
codigoOnix | string | Sim | Código do plano contratado. Só são aceitos os códigos listados em Planos. |
dataNascimento | string | Não | Data de nascimento, ex.: 1990-05-20. |
sexo | number | Não | Código numérico do sexo, conforme a tabela da rede de telemedicina. Se omitido, é enviado 1. |
email | string | Não | E-mail do beneficiário. |
telefone | string | Não | Telefone com DDD, ex.: 11999998888. |
cep | string | Não | CEP, com ou sem máscara. |
logradouro | string | Não | Rua, avenida etc. |
numeroEndereco | string | Não | Número do endereço. |
complemento | string | Não | Complemento do endereço. |
bairro | string | Não | Bairro. |
cidade | string | Não | Cidade. |
estado | string | Não | UF com 2 letras, ex.: SP. |
Somente os campos acima:
Qualquer campo fora desta lista faz a requisição ser rejeitada com 400, por exemplo: property numerodasorte should not exist.
Exemplo de corpo
{
"nome": "Maria da Silva",
"cpf": "123.456.789-09",
"codigoOnix": "7426",
"dataNascimento": "1990-05-20",
"sexo": 2,
"email": "maria@exemplo.com",
"telefone": "11999998888",
"cep": "01001-000",
"logradouro": "Praça da Sé",
"numeroEndereco": "100",
"complemento": "Sala 1",
"bairro": "Sé",
"cidade": "São Paulo",
"estado": "SP"
}
Exemplos
curl -X POST https://api.sauddy.com.br/v1/TeleMedicina/Adesao \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"nome": "Maria da Silva",
"cpf": "123.456.789-09",
"codigoOnix": "7426",
"email": "maria@exemplo.com",
"telefone": "11999998888"
}'
Resposta de sucesso — 201 Created
{
"data": {
"nome": "Maria da Silva",
"cpf": "12345678909",
"codOnix": "7426",
"numeroCartao": "1234567890123456",
"status": "1",
"message": "",
"email": "maria@exemplo.com",
"telefone": "11999998888",
"data_nascimento": "1990-05-20",
"cep": "01001000",
"logradouro": "Praça da Sé",
"bairro": "Sé",
"cidade": "São Paulo"
},
"errorMessage": "",
"success": true
}
Campo de data | Tipo | Descrição |
|---|---|---|
numeroCartao | string | Número do cartão do beneficiário. Guarde este valor. |
codOnix | string | Código do plano contratado. |
cpf | string | CPF do beneficiário (somente dígitos). |
nome | string | Nome do beneficiário. |
status | string | Status do contrato. Veja Status do contrato. |
message | string | Mensagem informativa (pode vir vazia). |
email, telefone, data_nascimento, cep, logradouro, bairro, cidade | string | Dados cadastrais do beneficiário (vazios quando não informados). |
Regras de negócio
- Sem duplicidade: se o CPF já tiver um contrato ativo ou suspenso no mesmo plano (
codigoOnix) na sua empresa, nenhum contrato novo é criado. A API responde com sucesso, devolve onumeroCartaoexistente e a mensagemContrato já existente para este CPF e plano.. - Contrato cancelado: uma nova adesão para um CPF cujo contrato no plano foi cancelado cria um novo contrato, com novo
numeroCartao. - Planos diferentes: o mesmo CPF pode ter contratos em planos diferentes.
- Homologação: nada é gravado. A resposta tem o mesmo formato, com
numeroCartaono padrãoSDY-HOMOL-...e a mensagemAdesão registrada (homologação)..
Erros
| HTTP | Quando acontece | message |
|---|---|---|
400 | Campo obrigatório ausente ou vazio | Lista dos problemas, ex.: ["nome should not be empty"] |
400 | Campo não documentado no corpo | ["property <campo> should not exist"] |
400 | CPF com menos de 11 dígitos | CPF inválido. |
400 | codigoOnix que não é um plano válido (também em homologação) | codigoOnix inválido: "9999". Códigos aceitos: ... |
401 | Token ausente | Token não informado. |
401 | Token inválido ou expirado | Token inválido ou expirado. |
503 | A rede de telemedicina não confirmou a adesão | Detalhes retornados pela rede de telemedicina |
Tempo de resposta:
Em produção, a adesão é confirmada junto à rede de telemedicina antes de responder, o que pode levar até cerca de um minuto. Use um timeout de pelo menos 90 segundos nesta chamada.