Esta API retorna os dados da carteirinha do beneficiário informado, incluindo as imagens do cartão frente e verso. As informações relacionadas à montagem dos dados da carteirinha são retornadas, bem como campos customizados, permitindo uma configuração dinâmica da exibição do cartão no frontend.
Clique aqui para detalhes sobre como habilitar o serviço de APIs no Protheus.
|
| Nome | Tipo | Descrição |
|---|---|---|
Content-Type (header) | string | 'application/json' é o formato do conteúdo |
| Authorization (Header) | string | Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>. *required |
| subscriberId (Path) | string | Identificador único da carteirinha do beneficiário. *required |
Retorna os dados da carteirinha do beneficiário, incluindo informações pessoais, planos de saúde, imagens do cartão e configurações de layout. |
{
"fields": {
"name": "Marli Brenda Viana",
"socialName": "",
"healthInsurerCode": "0001",
"companyCode": "0101",
"registrationCode": "000007",
"kinshipCode": "53",
"digit": "5",
"nationalHealthCard": "",
"subscriberId": "00010101000007535",
"birthDate": "1997-10-07",
"cardValidity": "",
"effectiveDate": "2020-12-28",
"cardCopy": "06",
"holderName": "LUCAS NONATO",
"holderHealthInsurerCode": "",
"holderCompanyCode": "0101",
"holderRegistrationCode": "000007",
"holderKinshipCode": "01",
"holderDigit": "2",
"holderSubscriberId": "00010101000007012",
"dependentName": "Marli Brenda Viana",
"dependentHealthInsurerCode": "0001",
"dependentCompanyCode": "0101",
"dependentRegistrationCode": "000007",
"dependentKinshipCode": "53",
"dependentDigit": "5",
"dependentSubscriberId": "00010101000007535",
"planCode": "0001",
"planDescription": "PLANO DOS GRANDE",
"accommodationDescription": "INDIVIDUAL",
"coverageArea": "GRUPO DE ESTADOS",
"planRegulation": "PLANO REGULAMENTADO",
"planCodeANS": "123456",
"planSegmentation": "AMBULATORIAL",
"subcontractCardName": "",
"healthInsurerCodeANS": "888888",
"healthInsurerName": "OPERADORA SAÚDE 888888"
},
"cardImage": {
"front": "",
"back": ""
},
"layoutConfig": {
"front": [
{
"css": "font-size: 9px;font-weight: bold;top: 50px; width: 200px; left: 300px;",
"values": [
{
"type": "custom",
"value": "meuCampo"
}
]
},
{
"css": "font-size: 9px;font-weight: bold;top: 70px; width: 200px; left: 20px;",
"values": [
{
"type": "field",
"value": "planDescription"
},
{
"type": "field",
"value": "accommodationDescription"
}
]
},
{
"css": "font-size: 8px;top: 117px; width: 70px; left: 330px;",
"values": [
{
"type": "text",
"value": "VÁLIDO ATÉ:"
}
]
}
],
"back": [
{
"css": "font-size: 9px;font-weight: bold;top: 70px; width: 200px; left: 100px;",
"values": [
{
"type": "field",
"value": "planDescription"
},
{
"type": "field",
"value": "accommodationDescription"
}
]
}
]
},
"customFields": [
{
"field": "meuCampo",
"value": "Meu valor customizado"
}
]
} |
Exemplo de resposta:
Coloque o link das tabelas relacionadas