Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

CONTEÚDO

  1. Introdução
  2. Endpoint
  3. ParâmetParâmetros
  4. Tabelas utilizadasResposta


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.

...

Estado
subtletrue
colourBlue
titleGET
/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/card

03. PARÂMETROS

NomeTipoDescrição

Content-Type (header)

string

'application/json' é o formato do conteúdo
Authorization (Header)stringToken de acesso obtido via a API de autenticação, no formato Bearer <access_token>. *required
subscriberId (Path)stringIdentificador único da carteirinha do beneficiário. *required
Expandir
titleParameters
NomeTipoDescrição

Content-Type (header)

string

'application/json' é o formato do conteúdo
Authorization (Header)stringToken de acesso obtido via a API de autenticação, no formato Bearer <access_token>. *required
subscriberId (Path)stringIdentificador único da carteirinha do beneficiário. *required
Nota
Expandir
titleParameters
NomeTipoDescrição

Content-Type (header)

string

'application/json' é o formato do conteúdo
Authorization (Header)stringToken de acesso obtido via a API de autenticação, no formato Bearer <access_token>. *required
subscriberId (Path)stringIdentificador único da carteirinha do beneficiário. *required

04. RESPOSTA

...

04. RESPOSTA

200 - OK

Dica
iconfalse
title200 - Sucesso

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

...