Linha Microsiga Protheus

Árvore de páginas


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Cards - Inclusão de uma nova via do cartão de identificação do beneficiário
  3. Tela api cards
    1. Outras Ações / Ações relacionadas
  4. Tela api cards
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade cards (Cartão de Identificação) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs


Autenticação das APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items


02. EXEMPLO DE UTILIZAÇÃO

Cards - Inclusão de uma nova via do cartão de identificação do beneficiário

Realiza a inclusão de um nova via do cartão de identificação do beneficiário pelo lançamento avulso.

/totvsHealthPlans/identificationCard/v1/cards

POST

Authorization (header)

string

Cabeçalho usado para autorização das requisições (Bearer token)*required

Content-Type (header)

string

'application/json' é o formato do conteúdo*required
subscriberIdstring

Matricula do beneficiário

(obtido através da API Beneficiaries - v1.000 (Family Contract))

BED_USUARI*required

reason

stringMotivo de emissão (tabela BPX)BED_MOTIVO*required
expirationDatestring

Nova data de validade do cartão do beneficiário

BED_DATVAL*required
cardNameTypestring

Define como será impresso o nome no cartão, sendo:

  • 1 = Nome Cart. (Nome Cart. - BTS_NOMCAR)
  • 2 = Nome Usuário (Nome - BTS_NOMUSR).
BED_NOMCAR*required
Exemplo
{
    "subscriberId" : "00011008000032005",
    "reason" : "2",
    "expirationDate" : "2024-03-17",
    "cardNameType" : "1"
}
protocolstringNumero do protocolo da solicitação de via do cartãoBED_PROTOC*required
subscriberIdstring

Matricula do beneficiário solicitante

BED_USUARI*required
namestringNome do beneficiário solicitanteBED_NOMUSR*required
cardCopynumeric (integer)Numero de vias de cartão do beneficiárioBED_VIACAR*required
expirationDatestring (date)Data de validade do cartãoBED_DATVAL*required
requestDatestring (date)Data da solicitaçãoBED_DTSOLI*required
billingstring

Define se terá cobrança a nova via de cartão, sendo:

  • 0 = Não
  • 1 = Sim
BED_COBRAR*required
Valuenumeric (double)

Valor de cobrança da nova via de cartão quando o billing for igual a 1

BED_VALOR
Exemplo
{
    "protocol": "000000000003",
    "subscriberId": "00011008000032005",
    "name": "PRISCILA FABIANA ALVES",
    "cardCopy": 2,
    "expirationDate": "2024-03-17",
    "requestDate": "2023-06-20",
    "billing": "0",
    "Value": 0
}
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Exemplo
{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave subscriberId obrigatória",
            "detailedMessage": "Não foi informado no body da requisição a chave subscriberId."
        },
        {
            "code": "E001-406",
            "message": "Chave reason obrigatória",
            "detailedMessage": "Não foi informado no body da requisição a chave reason."
        },
        {
            "code": "E001-406",
            "message": "Chave expirationDate obrigatória",
            "detailedMessage": "Não foi informado no body da requisição a chave expirationDate."
        },
        {
            "code": "E001-406",
            "message": "Chave cardNameType obrigatória",
            "detailedMessage": "Não foi informado no body da requisição a chave cardNameType."
        }
    ]
}

03. TELA CARDS

Outras Ações / Ações relacionadas

AçãoDescrição
Não se aplicaNão se aplica

04. TELA CARDS

Principais Campos e Parâmetros

CampoDescrição
BED_PROTOCNumero do protocolo da solicitação de via do cartão
BED_MOTIVOMotivo de emissão
BED_USUARIMatricula do beneficiário

05. TABELAS UTILIZADAS

  • Beneficiários (BA1)
  • Motivos Emissão Carteira (BPX)
  • Cobranças Vias de Carteirinhas (BED)