...
- Visão Geral
- Exemplo de utilização
- Cards - Inclusão de uma nova via do cartão de identificação do beneficiário
- Tela api cardsTela XXX
- Outras Ações / Ações relacionadas
- Tela XXXapi cards
- Principais Campos e Parâmetros
- 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
Dica |
---|
title | 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. |
Informações |
---|
title | 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
Painel |
---|
titleColor | Orange |
---|
borderStyle | solid |
---|
title | 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 | |
Nota |
---|
Expandir |
---|
| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required |
|
|
Dica |
---|
Expandir |
---|
| subscriberId | string | Matricula do beneficiário (obtido através da API Beneficiaries - v1.000 (Family Contract)) | BED_USUARI | *required | reason | string | Motivo de emissão (tabela BPX) | BED_MOTIVO | *required | expirationDate | string | Nova data de validade do cartão do beneficiário | BED_DATVAL | *required | cardNameType | string | 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 |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"subscriberId" : "00011008000032005",
"reason" : "2",
"expirationDate" : "2024-03-17",
"cardNameType" : "1"
} |
|
|
Dica |
---|
Expandir |
---|
title | (201) - Operação realizada com sucesso |
---|
| protocol | string | Numero do protocolo da solicitação de via do cartão | BED_PROTOC | *required | subscriberId | string | Matricula do beneficiário solicitante | BED_USUARI | *required | name | string | Nome do beneficiário solicitante | BED_NOMUSR | *required | cardCopy | numeric (integer) | Numero de vias de cartão do beneficiário | BED_VIACAR | *required | expirationDate | string (date) | Data de validade do cartão | BED_DATVAL | *required | requestDate | string (date) | Data da solicitação | BED_DTSOLI | *required | billing | string | Define se terá cobrança a nova via de cartão, sendo: | BED_COBRAR | *required | Value | numeric (double) | Valor de cobrança da nova via de cartão quando o billing for igual a 1 | BED_VALOR |
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"protocol": "000000000003",
"subscriberId": "00011008000032005",
"name": "PRISCILA FABIANA ALVES",
"cardCopy": 2,
"expirationDate": "2024-03-17",
"requestDate": "2023-06-20",
"billing": "0",
"Value": 0
} |
|
|
Aviso |
---|
Expandir |
---|
title | (406) - Campos inválidos |
---|
| code | string | Código identificador do erro. | *required | message | string | Literal no idioma da requisição descrevendo o erro para o usuário. |
|
|
|
...
| *required | detailedMessage | string | Mensagem técnica e mais detalhada do erro. | *required | details | array | Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal. | *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"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ção | Descrição |
---|
Não se aplica | Não se aplica |
04. TELA
...
CARDS
Principais Campos e Parâmetros
...
|
---|
BED_PROTOC | Numero do protocolo da solicitação de via do cartão |
BED_MOTIVO | Motivo de emissão |
BED_USUARI | Matricula do beneficiário |
...
05. TABELAS UTILIZADAS
- Beneficiários (BA1)
- Motivos Emissão Carteira (BPX)
- Cobranças Vias de Carteirinhas (BED)