Obter dados do beneficiário no Tasy

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v1/agendamentos/beneficiario/dados?cdUsuarioConvenio={{cdUsuarioConvenio}}&cpf={{cpf}}&cdPessoaFisica={{cdPessoaFisica}}

🔹 Produção

https://integracao.medsenior.com.br/api/v1/agendamentos/beneficiario/dados?cdUsuarioConvenio={{cdUsuarioConvenio}}&cpf={{cpf}}&cdPessoaFisica={{cdPessoaFisica}}

Informe pelo menos um identificador do beneficiário (cdUsuarioConvenio, cpf ou cdPessoaFisica). Chamadas sem parâmetros válidos retornam 400 Bad Request.

📌 Endpoint

GET /api/v1/agendamentos/beneficiario/dados

🔐 Autenticação

Este endpoint requer um token válido.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

Nome	Valor
accept	application/json
content-type	application/json

🔽 Parâmetros de Entrada (query string)

Nome	Tipo	Obrigatório	Descrição
cdUsuarioConvenio	string	Condicional	Código da carteirinha do beneficiário (CD_USUARIO_CONVENIO). Informar quando cpf e cdPessoaFisica não forem enviados.
cpf	string	Condicional	CPF sem pontuação (NR_CPF). Informar quando cdUsuarioConvenio e cdPessoaFisica não forem enviados.
cdPessoaFisica	long	Condicional	Identificador interno do beneficiário no Tasy (CD_PESSOA_FISICA). Informar quando cdUsuarioConvenio e cpf não forem enviados.

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'GET' \
  'https://integracao.hml.cloud.medsenior.com.br/api/v1/agendamentos/beneficiarios/dados?cpf=12345678901' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
  -H 'content-type: application/json'

🔹 Ambiente de produção

curl -X 'GET' \
  'https://integracao.medsenior.com.br/api/v1/agendamentos/beneficiarios/dados?cdUsuarioConvenio=MS123456' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
  -H 'content-type: application/json'

✅ Resposta de Sucesso

• Status Code: 200 OK
• Exemplo de Resposta:

{
  "REF_CURSOR_P": [
    {
      "CD_PESSOA_FISICA": 11223344,
      "NM_PESSOA_FISICA": "João da Silva",
      "IE_SEXO": "M",
      "DT_NASCIMENTO": "1960-03-25T00:00:00",
      "NR_CPF": "12345678901",
      "NR_DDD_CELULAR": "27",
      "NR_TELEFONE_CELULAR": "999998888",
      "DS_EMAIL": "joao.silva@exemplo.com",
      "DS_MUNICIPIO": "Vitória",
      "UF": "ES",
      "CD_USUARIO_CONVENIO": "MS123456",
      "CD_CONVENIO": 50,
      "DS_CONVENIO": "MedSênior",
      "CD_PLANO": 7,
      "DS_PLANO": "Premium",
      "CD_CATEGORIA": 2
    }
  ],
  "CODIGO_P": "0",
  "MENSAGEM_P": "Consulta realizada!"
}

ℹ️ Observações de negócio

• O endpoint executa a procedure API_MS_JORNADA_DIG_PCK.MS_DADOS_BENEFICIARIO e retorna o payload no mesmo formato fornecido pelo Oracle (REF_CURSOR_P, CODIGO_P, MENSAGEM_P).
• Normalmente apenas um registro é retornado em REF_CURSOR_P, mas dependentes adicionais podem aparecer quando compartilham o mesmo CPF/conveniado.
• DT_NASCIMENTO segue o padrão ISO (yyyy-MM-ddTHH:mm:ss). Campos de telefone ou e-mail podem vir vazios quando o cadastro Tasy não possui valores.
• CODIGO_P = "0" indica sucesso, CODIGO_P = "1" representa beneficiário não encontrado e CODIGO_P = "9" sinaliza erro na procedure (ver MENSAGEM_P).

❌ Códigos de Erro

Status Code	Significado	Descrição
400	Bad Request	Nenhum identificador informado ou parâmetros informados com valores em branco.
401	Unauthorized	Token ausente ou inválido.
404	Not Found	Procedure retornou CODIGO_P = "1" (beneficiário não localizado).
500	Server Error	Falha no Tasy/Oracle (CODIGO_P = "9" ou outro código diferente de 0).