CONTEÚDO
- Introdução
- Endpoint
- Tabelas utilizadas
01. INTRODUÇÃO
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.
02. ENDPOINT
| /totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/card |
03. PARÂMETROS
| Nome | Tipo | Descrição |
|---|
Content-Type (header) | | '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 |
|
| Nome | Tipo | Descrição |
|---|
Content-Type (header) | | '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 |
|
|
04. RESPOSTA
200 - OK
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.
Exemplo de resposta:
05. TABELAS UTILIZADAS
Coloque o link das tabelas relacionadas