Obter contatos do beneficiário
🌐 URLs dos Ambientes
🔹 Homologação
https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/beneficiarios/{{cpfBeneficiario}}
🔹 Produção
https://integracao.medsenior.com.br/api/v1/beneficiario/beneficiarios/{{cpfBeneficiario}}
📌 Endpoint
GET /api/v1/beneficiario/beneficiarios/{{cpfBeneficiario}}
🔐 Autenticação
Este endpoint requer um token de autorização.
Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO
🔽 Cabeçalhos
Nome | Valor |
---|---|
accept | application/json |
content-type | application/json |
🔽 Parâmetros de Entrada
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
cpfBenficiario | string | Sim | Parametro a ser enviado junto à url |
🔄 Exemplo de Requisição
🔹 Ambiente de homologação
curl -X 'GET' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/beneficiarios/{{cpfBeneficiario}}' \
-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/beneficiario/usuabeneficiariosrio/{{cpfBeneficiario}}' \
-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:
{
"data": {
"contatos": [
{
"id": "bed1066b-d8b5-47bc-a67f-2fd70a3c442d",
"sequencial": 294103,
"contato": "vivi*******se@gmail.com",
"tipoContato": 4 // 1-Telefone fixo, 2-Celular, 3-Fax, 4-Email
},
{
"id": "bdc27b6a-c758-455d-8066-82601c578ff7",
"sequencial": 470597,
"contato": "119******39",
"tipoContato": 2
},
{
"id": "056b86da-ea35-4187-b71f-b7df7ebcab46",
"sequencial": 577070,
"contato": "279******24",
"tipoContato": 2
}
]
},
"isSuccess": true,
"isFailure": false
}
❌ Códigos de Erro
Status Code | Significado | Descrição |
---|---|---|
400 | Bad Request | Parâmetros inválidos ou ausentes. |
401 | Unauthorized | Falha na autenticação do token. |
500 | Server Error | Erro interno ao obter o beneficiário |