Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 3

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

Chave

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

...

CONTEÚDO

  1. Introdução
  2. Endpoint
  3. Parâmetros
  4. RespostaTabelas 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

Estado

...

...

colourBlue
titleGET

...

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/card

03. PARÂMETROS

...

Nome

...

titleParameters
TipoDescrição

Content-Type 

...

string

...

(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>.

Estado
subtletrue
colourRed
titleRequired

subscriberId (Path)string

Identificador único da carteirinha do beneficiário.

Estado
subtletrue
colourRed
titleRequired

04. RESPOSTA

Filtro de beneficiários pela carteirinha (
Informações
iconfalse
Dica

200 - Operação realizada com 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.

Código da operadora (BA1_CODINT)*requiredlogin-user (query)stringFiltro de beneficiários pelo usuário de login do portal (BSW_LOGUSR)allFamily (query)string

Define se será retornado todos os beneficiários do login, quando utilizado o query param loginUser, sendo:

  • 0 - Não
  • 1 - Sim
companyCode (query)stringFiltro de beneficiários por empresa (BA1_CODEMP)contractcode (query)string

Filtro de beneficiários por contrato (BA1_CONEMP)

contractVersionCode (query)string

Filtro de beneficiários por versão do contrato (BA1_VERCON)

subcontractCode (query)string

Filtro de beneficiários por subcontrato (BA1_SUBCON)

subcontractVersioncode (query)string

Filtro de beneficiários por versão do subcontrato (BA1_VERSUB)

familycode (query)stringFiltro de beneficiários por código da família (BA1_MATRIC)name (query)stringFiltro de beneficiários por nomesocialName (query)stringFiltro de beneficiários por nome socialbeneficiaryType (query)string

Filtro de beneficiários por tipo (BA1_TIPUSU), sendo:

  • T - Titular
  • D - Dependente
  • A - Agregado
situation (query)string

Filtro de beneficiários por situação, sendo:

  • 1 - Ativo
  • 2 - Inclusão futura
  • 3 - Bloqueio futuro
  • 4 - Bloqueado
subscriberId (query)string
CampoTipoDescriçãoCampo (Protheus)
fields 

Estado
subtletrue
titleobject



fields.name 

Estado
subtletrue
titlestring

Nome completo do beneficiário.BTS_NOMCAR ou BTS_NOMUSR
fields.socialName

Estado
subtletrue
titlestring

Nome social do beneficiário.

BTS_NOMSOC

fields.healthInsurerCode

Estado
subtletrue
titlestring

Código da operadora de saúde.

BA1_CODINT

fields.companyCode 

Estado
subtletrue
titlestring

Código da empresa.

BA1_CODEMP

fields.registrationCode 

Estado
subtletrue
titlestring

Código de registro do beneficiário.

BA1_MATRIC

fields.kinshipCode 

Estado
subtletrue
titlestring

Código de parentesco.

BA1_TIPREG

fields.digit 

Estado
subtletrue
titlestring

Dígito de identificação.

BA1_DIGITO

fields.nationalHealthCard 

Estado
subtletrue
titlestring

Número do cartão nacional de saúde

BTS_NRCRNA

fields.subscriberId 

Estado
subtletrue
titlestring

Identificador único do beneficiário.BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO
fields.birthDate 

Estado
subtletrue
titleString (date)

Data de nascimento do beneficiário.

BA1_DATNAS

fields.cardValidity 

Estado
subtletrue
titleString (date)

Data de validade do cartão.

BA1_DTVLCR

fields.effectiveDate 

Estado
subtletrue
titleString (date)

Data de efetivação do plano de saúde.

BA1_DATINC

fields.cardCopy 

Estado
subtletrue
titlestring

Identificador da cópia do cartão.

BA1_VIACAR

fields.holderName 

Estado
subtletrue
titlestring

Nome do titular do plano.BTS_NOMCAR ou BTS_NOMUSR
fields.holderHealthInsurerCode 

Estado
subtletrue
titlestring

Código da operadora de saúde do titular.

BA1_CODINT

fields.holderCompanyCode 

Estado
subtletrue
titlestring

Código da empresa do titular.

BA1_CODEMP

fields.holderRegistrationCode

Estado
subtletrue
titlestring

Código de registro do titular.

BA1_MATRIC

fields.holderKinshipCode 

Estado
subtletrue
titlestring

Código de parentesco do titular.

BA1_TIPREG

fields.holderDigit 

Estado
subtletrue
titlestring

Dígito de identificação do titular.

BA1_DIGITO

fields.holderSubscriberId 

Estado
subtletrue
titlestring

Identificador único do titular.BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO
fields.dependentName 

Estado
subtletrue
titlestring

Nome do dependente.BTS_NOMCAR ou BTS_NOMUSR
fields.dependentHealthInsurerCode 

Estado
subtletrue
titlestring

Código da operadora de saúde do dependente.

BA1_CODINT

fields.dependentCompanyCode

Estado
subtletrue
titlestring

Código da empresa do dependente.

BA1_CODEMP

fields.dependentRegistrationCode 

Estado
subtletrue
titlestring

Código de registro do dependente.

BA1_MATRIC

fields.dependentKinshipCode 

Estado
subtletrue
titlestring

Código de parentesco do dependente.

BA1_TIPREG

fields.dependentDigit 

Estado
subtletrue
titlestring

Dígito de identificação do dependente.

BA1_DIGITO

fields.dependentSubscriberId 

Estado
subtletrue
titlestring

Identificador único do dependente.
BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO
)subscriberIdOrCpfstring

Filtro de beneficiários pela carteirinha ou cpf

page (query)

string

Valor numérico (maior que zero) representando a página solicitadapageSize (query)

string

Valor numérico (maior que zero) representando o total de registros retornados na consultaorder (query)

string

Lista de campos para ordenação, separada por virgula (,).fields (query)

string

Lista com o nome das propriedades JSON que serão retornadas.filter (query)

string

Filtros seguindo o padrão ODATA
NomeTipoDescrição
subscriberId (Path)stringIdentificador único da carteirinha do beneficiário. Obrigatório
Authorization (Header)stringToken de acesso obtido via a API de autenticação, no formato Bearer <access_token>. Obrigatório

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:

...

fields.planCode 

Estado
subtletrue
titlestring

Código do plano.

BI3_CODIGO

fields.planDescription 

Estado
subtletrue
titlestring

Descrição do plano de saúde.

BI3_NREDUZ

fields.accommodationDescription 

Estado
subtletrue
titlestring

Descrição da acomodação do plano.

BI4_CODEDI

fields.coverageArea 

Estado
subtletrue
titlestring

Área de cobertura do plano de saúde.

BI3_ABRANG

fields.planRegulation 

Estado
subtletrue
titlestring

Tipo de regulamentação do plano.

BI3_APOSRG

fields.planCodeANS 

Estado
subtletrue
titlestring

Código do plano na ANS.

BI3_SUSEP ou BI3_SCPA

fields.planSegmentation 

Estado
subtletrue
titlestring

Segmentação do plano.

BI6_DESCRI

fields.subcontractCardName 

Estado
subtletrue
titlestring

Nome do cartão de subcontrato.

BQC_NOMCAR

fields.healthInsurerCodeANS 

Estado
subtletrue
titlestring

Código da operadora de saúde na ANS.

BA0_SUSEP

fields.healthInsurerName 

Estado
subtletrue
titlestring

Nome da operadora de saúde.

BA0_NOMINT

cardImage 

Estado
subtletrue
titleobject



cardImage.front 

Estado
subtletrue
titlestring

Imagem em base64 da frente do cartão (formato PNG).
cardImage.back 

Estado
subtletrue
titlestring

Imagem em base64 da verso do cartão (formato PNG).
layoutConfig 

Estado
subtletrue
titleobject



layoutConfig.front 

Estado
subtletrue
titleobject[]

Configurações de layout para a frente do cartão.
layoutConfig.front.css 

Estado
subtletrue
titlestring

Estilo CSS para o campo.
layoutConfig.front.values

Estado
subtletrue
titleobject[]

Valores a serem exibidos no campo.
layoutConfig.front.values.type

Estado
subtletrue
titlestring

Tipo do campo, podendo ser: custom, field ou text.
layoutConfig.front.values.value

Estado
subtletrue
titlestring

Valor do campo.
layoutConfig.back

Estado
subtletrue
titleobject[]

Configurações de layout para o verso do cartão.
layoutConfig.back.css 

Estado
subtletrue
titlestring

Estilo CSS para o campo.
layoutConfig.back.values

Estado
subtletrue
titleobject[]

Valores a serem exibidos no campo.
layoutConfig.back.values.type

Estado
subtletrue
titlestring

Tipo do campo, podendo ser: custom, field ou text.
layoutConfig.back.values.value

Estado
subtletrue
titlestring

Valor do campo.
customFields 

Estado
subtletrue
titleobject[]



customFields.field

Estado
subtletrue
titlestring

Nome do campo customizado.
customFields.value

Estado
subtletrue
titlestring

Valor do campo customizado.
Bloco de código
languagec#
themeMidnight
titleExemplo
collapsetrue
{

   "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"
    }
  ]
}
Nota

Campos Customizados

O campo customFields permite que o cliente adicione campos personalizados à resposta, oferecendo flexibilidade para configurar os dados da carteirinha conforme necessário. Utilize o ponto de entrada: PE PTBENCARD Campos Customizados para Carteirinha Virtual no Portal do Beneficiário


Imagens do Cartão

As imagens do cartão (frente e verso) são fornecidas em formato PNG, com tamanho de 420x240 pixels. As imagens são nomeadas como front-card.png e back-card.png e estão localizadas no diretório do servidor:

RootPath: \portais-saude\portal-beneficiario\card\


Arquivo de Configuração de Layout

No mesmo diretório das imagens, um arquivo de configuração chamado layout-config.json. Este arquivo contém as definições para os campos que aparecerão no cartão, incluindo o layout de posicionamento e estilo CSS.

Para mais detalhes sobre a configuração da imagem e do layout, consulte a documentação Configuração do Layout Customizado da Carteirinha

Informações
iconfalse
Aviso

404 - Beneficiário não encontrado

Caso o subscriberId informado não seja encontrado no sistema, a API retornará o código de erro E001 com uma mensagem detalhada.

CampoTipoDescrição
code

Estado
subtletrue
titlestring

Código identificador do erro.
message

Estado
subtletrue
titlestring

Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage

Estado
subtletrue
titlestring

Mensagem técnica e mais detalhada do erro.
Bloco de código
languagec#
themeMidnight
titleExemplo
collapsetrue
{
  "code": "E001",
  "message": "Não foi possível localizar o beneficiário informado no sistema. Por favor, verifique os dados fornecidos e tente novamente.",
  "detailedMessage": "O path informado (subscriberId) não foi encontrado na tabela de beneficiários (BA1). A consulta considerou os seguintes campos: BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG e BA1_DIGITO. Verifique os dados enviados e tente novamente."
}