Exibir origem

CONTEÚDO

Introdução
Endpoint
Parâmetros
Resposta

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)	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

04. RESPOSTA

Campo	Tipo	Descrição
fields	objeto
fields.name	string	Nome completo do beneficiário.
fields.socialName	string	Nome social do beneficiário.
fields.healthInsurerCode	string	Código da operadora de saúde.
fields.companyCode	string	Código da empresa.
fields.registrationCode	string	Código de registro do beneficiário.
fields.kinshipCode	string	Código de parentesco.
fields.digit	string	Dígito de identificação.
fields.nationalHealthCard	string	Número do cartão nacional de saúde
fields.subscriberId	string	Identificador único do beneficiário.
fields.birthDate	string - data	Data de nascimento do beneficiário.
fields.cardValidity	string - data	Data de validade do cartão.
fields.effectiveDate	string - data	Data de efetivação do plano de saúde.
fields.cardCopy	string	Identificador da cópia do cartão.
fields.holderName	string	Nome do titular do plano.
fields.holderHealthInsurerCode	string	Código da operadora de saúde do titular.
fields.holderCompanyCode	string	Código da empresa do titular.
fields.holderRegistrationCode	string	Código de registro do titular.
fields.holderKinshipCode	string	Código de parentesco do titular.
fields.holderDigit	string	Dígito de identificação do titular.
fields.holderSubscriberId	string	Identificador único do titular.
fields.dependentName	string	Nome do dependente.
fields.dependentHealthInsurerCode	string	Código da operadora de saúde do dependente.
fields.dependentCompanyCode	string	Código da empresa do dependente.
fields.dependentRegistrationCode	string	Código de registro do dependente.
fields.dependentKinshipCode	string	Código de parentesco do dependente.
fields.dependentDigit	string	Dígito de identificação do dependente.
fields.dependentSubscriberId	string	Identificador único do dependente.
fields.planCode	string	Código do plano.
fields.planDescription	string	Descrição do plano de saúde.
fields.accommodationDescription	string	Descrição da acomodação do plano.
fields.coverageArea	string	Área de cobertura do plano de saúde.
fields.planRegulation	string	Tipo de regulamentação do plano.
fields.planCodeANS	string	Código do plano na ANS.
fields.planSegmentation	string	Segmentação do plano.
fields.subcontractCardName	string	Nome do cartão de subcontrato.
fields.healthInsurerCodeANS	string	Código da operadora de saúde na ANS.
fields.healthInsurerName	string	Nome da operadora de saúde.
cardImage	objeto
cardImage.front	string	Imagem em base64 da frente do cartão (formato PNG).
cardImage.back	string	Imagem em base64 da verso do cartão (formato PNG).
layoutConfig	objeto
layoutConfig.front	array de objetos	Configurações de layout para a frente do cartão.
layoutConfig.front.css	string	Estilo CSS para o campo.
layoutConfig.front.values	array de objetos	Valores a serem exibidos no campo.
layoutConfig.front.values.type	string	Tipo do campo, podendo ser: custom, field ou text.
layoutConfig.front.values.value	string	Valor do campo.
layoutConfig.back	array de objetos	Configurações de layout para o verso do cartão.
layoutConfig.back.css	string	Estilo CSS para o campo.
layoutConfig.back.values	array de objetos	Valores a serem exibidos no campo.
layoutConfig.back.values.type	string	Tipo do campo, podendo ser: custom, field ou text.
layoutConfig.back.values.value	string	Valor do campo.
customFields	array de objetos
customFields.field	string	Nome do campo customizado.
customFields.value	string	Valor do campo customizado.

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.

Campo	Tipo	Descrição
fields	objeto
fields.name	string	Nome completo do beneficiário.
fields.socialName	string	Nome social do beneficiário.
fields.healthInsurerCode	string	Código da operadora de saúde.
fields.companyCode	string	Código da empresa.
fields.registrationCode	string	Código de registro do beneficiário.
fields.kinshipCode	string	Código de parentesco.
fields.digit	string	Dígito de identificação.
fields.nationalHealthCard	string	Número do cartão nacional de saúde
fields.subscriberId	string	Identificador único do beneficiário.
fields.birthDate	string - data	Data de nascimento do beneficiário.
fields.cardValidity	string - data	Data de validade do cartão.
fields.effectiveDate	string - data	Data de efetivação do plano de saúde.
fields.cardCopy	string	Identificador da cópia do cartão.
fields.holderName	string	Nome do titular do plano.
fields.holderHealthInsurerCode	string	Código da operadora de saúde do titular.
fields.holderCompanyCode	string	Código da empresa do titular.
fields.holderRegistrationCode	string	Código de registro do titular.
fields.holderKinshipCode	string	Código de parentesco do titular.
fields.holderDigit	string	Dígito de identificação do titular.
fields.holderSubscriberId	string	Identificador único do titular.
fields.dependentName	string	Nome do dependente.
fields.dependentHealthInsurerCode	string	Código da operadora de saúde do dependente.
fields.dependentCompanyCode	string	Código da empresa do dependente.
fields.dependentRegistrationCode	string	Código de registro do dependente.
fields.dependentKinshipCode	string	Código de parentesco do dependente.
fields.dependentDigit	string	Dígito de identificação do dependente.
fields.dependentSubscriberId	string	Identificador único do dependente.
fields.planCode	string	Código do plano.
fields.planDescription	string	Descrição do plano de saúde.
fields.accommodationDescription	string	Descrição da acomodação do plano.
fields.coverageArea	string	Área de cobertura do plano de saúde.
fields.planRegulation	string	Tipo de regulamentação do plano.
fields.planCodeANS	string	Código do plano na ANS.
fields.planSegmentation	string	Segmentação do plano.
fields.subcontractCardName	string	Nome do cartão de subcontrato.
fields.healthInsurerCodeANS	string	Código da operadora de saúde na ANS.
fields.healthInsurerName	string	Nome da operadora de saúde.
cardImage	objeto
cardImage.front	string	Imagem em base64 da frente do cartão (formato PNG).
cardImage.back	string	Imagem em base64 da verso do cartão (formato PNG).
layoutConfig	objeto
layoutConfig.front	array de objetos	Configurações de layout para a frente do cartão.
layoutConfig.front.css	string	Estilo CSS para o campo.
layoutConfig.front.values	array de objetos	Valores a serem exibidos no campo.
layoutConfig.front.values.type	string	Tipo do campo, podendo ser: custom, field ou text.
layoutConfig.front.values.value	string	Valor do campo.
layoutConfig.back	array de objetos	Configurações de layout para o verso do cartão.
layoutConfig.back.css	string	Estilo CSS para o campo.
layoutConfig.back.values	array de objetos	Valores a serem exibidos no campo.
layoutConfig.back.values.type	string	Tipo do campo, podendo ser: custom, field ou text.
layoutConfig.back.values.value	string	Valor do campo.
customFields	array de objetos
customFields.field	string	Nome do campo customizado.
customFields.value	string	Valor do campo customizado.

{

   "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:

05. TABELAS UTILIZADAS

Coloque o link das tabelas relacionadas