Adesão

Cadastra um beneficiário em um plano de telemedicina.

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

CampoTipoObrigatórioDescrição
nomestringSimNome completo do beneficiário.
cpfstringSimCPF do beneficiário, com ou sem máscara. Deve ter 11 dígitos.
codigoOnixstringSimCódigo do plano contratado. Só são aceitos os códigos listados em Planos.
dataNascimentostringNãoData de nascimento, ex.: 1990-05-20.
sexonumberNãoCódigo numérico do sexo, conforme a tabela da rede de telemedicina. Se omitido, é enviado 1.
emailstringNãoE-mail do beneficiário.
telefonestringNãoTelefone com DDD, ex.: 11999998888.
cepstringNãoCEP, com ou sem máscara.
logradourostringNãoRua, avenida etc.
numeroEnderecostringNãoNúmero do endereço.
complementostringNãoComplemento do endereço.
bairrostringNãoBairro.
cidadestringNãoCidade.
estadostringNãoUF 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 dataTipoDescrição
numeroCartaostringNúmero do cartão do beneficiário. Guarde este valor.
codOnixstringCódigo do plano contratado.
cpfstringCPF do beneficiário (somente dígitos).
nomestringNome do beneficiário.
statusstringStatus do contrato. Veja Status do contrato.
messagestringMensagem informativa (pode vir vazia).
email, telefone, data_nascimento, cep, logradouro, bairro, cidadestringDados 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 o numeroCartao existente e a mensagem Contrato 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 numeroCartao no padrão SDY-HOMOL-... e a mensagem Adesão registrada (homologação)..

Erros

HTTPQuando acontecemessage
400Campo obrigatório ausente ou vazioLista dos problemas, ex.: ["nome should not be empty"]
400Campo não documentado no corpo["property <campo> should not exist"]
400CPF com menos de 11 dígitosCPF inválido.
400codigoOnix que não é um plano válido (também em homologação)codigoOnix inválido: "9999". Códigos aceitos: ...
401Token ausenteToken não informado.
401Token inválido ou expiradoToken inválido ou expirado.
503A rede de telemedicina não confirmou a adesãoDetalhes 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.