Árvore de páginas

Versões comparadas

Chave

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

...

Dica
titleAutenticaçã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
titleNomenclatura 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
titleColorOrange
borderStylesolid
titleBeneficiaries - Retorna os beneficiários da operadora de saúde

Retorna os beneficiários cadastrados na operadora de saúde.

/totvsHealthPlans/familyContract/v1/beneficiaries

GET

Nota
Expandir
titleParameters
health-insurer-code all-family login-usercompany-code contract-code contract-version-code subcontract-code subcontract-version-code family-code social-name beneficiary-type page
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
healthInsurerCode (query)stringCódigo da operadora (BA1_CODINT)*required
login-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 nome
socialName (query)stringFiltro de beneficiários por nome social
beneficiaryType (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
Valor numérico (maior que zero) representando a página solicitada

Filtro de beneficiários pela carteirinha (BA1_CODINT+BA1_CODEMP+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 solicitada
pageSize (pageSize (query)

string

Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (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
Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de beneficiários retornados

items.company-_codestring

Código da empresa do beneficiário

BA1_CODEMP*required
items.contract-_codestring

Código do contrato (Pessoa jurídica)

BA1_CONEMP
items.contract-_version-_codestringVersão do contrato (Pessoa jurídica)BA1_VERCON
items.subcontract-_codestringCódigo do subcontrato (Pessoa jurídica)BA1_SUBCON
items.subcontract-_version-_codestringVersão do subcontrato (Pessoa jurídica)BA1_VERSUB
items.family-_codestringCódigo da família do beneficiárioBA1_MATRIC*required
items.subscriber-_idstring

Matricula do beneficiário

BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO*required
items.namestringNome do beneficiárioBA1_NOMUSR*required
items.social-_namestringNome social do beneficiárioBA1_NOMSOC
items.birth-_datestring (date)Data de nascimento do beneficiárioBA1_DATNAS*required
items.effective-_datestring (date)Data de inclusão do beneficiárioBA1_DATINC*required
items.beneficiary-_typestring

Tipo do beneficiário, sendo:

  • T - Titular
  • D - Dependente
  • A - Agregado
BA1_TIPUSU*required
items.situationstring

Situação do beneficiário, sendo:

  • 1 - Ativo
  • 2 - Inclusão futura
  • 3 - Bloqueio futuro
  • 4 - Bloqueado
BA1_DATINC e BA1_DATBLO*required
items.block-_datestring (date)Data de bloqueio do beneficiárioBA1_DATBLO
items.beneficiary-_cpfstringNumero do CPF do beneficiárioBA1_CPFUSR_CPFUSR
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "items": [
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "items": [
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000001",
            "subcontract-version-code": "001",
            "family-code": "000001",
            "subscriber-id": "00011008000001010",
            "name": "CLODOALDO SILVA",
            "social-name": "",
            "birth-date": "1970-10-10",
            "effective-date": "2021-02-12",
            "beneficiary-type": "T",
            "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "51351540009"
        },
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "subcontract-code": "000000002",
            "subcontract-version-code": "001",
            "family-code": "000002",
            "subscriber-id": "00011008000002017",
            "name": "FABIANA SOPHIA MELO",
            "social-name": "",
            "birth-date": "1986-12-12",
            "effective-date": "2021-03-08",
            "beneficiary-type": "T",
            "situation": "1",
            "block-date": "",
            "beneficiary-cpf": "77476519965"
        },
        {
            "company-_code": "1008",
            "contract-_code": "000000000001",
            "contract-_version-_code": "001",
            "subcontract-_code": "000000003000000001",
            "subcontract-_version-_code": "001",
            "family-_code": "000003000001",
            "subscriber-_id": "0001100800000301300011008000001010",
            "name": "PAULOCLODOALDO AZEVEDOSILVA",
            "social-_name": "",
            "birth-_date": "19801970-10-1310",
            "effective-_date": "2021-0402-0512",
            "beneficiary-_type": "T",
            "situation": "1",
            "block-_date": "",
            "beneficiary-_cpf": "5555555555551351540009"
        },
        {
            "company-_code": "1008",
            "contract-_code": "000000000001",
            "contract-_version-_code": "001",
            "subcontract-_code": "000000003000000002",
            "subcontract-_version-_code": "001",
            "family-_code": "000004000002",
            "subscriber-_id": "0001100800000401000011008000002017",
            "name": "ANDREFABIANA SOPHIA MELO",
            "social-_name": "",
            "birth-_date": "19851986-0112-1712",
            "effective-_date": "2021-0403-2708",
            "beneficiary-_type": "T",
            "situation": "1",
            "block-_date": "",
            "beneficiary-_cpf": "5301789589077476519965"
        }
    ],
    "hasNext": true,
    "remainingRecords": 37
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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 health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

...

Painel
titleColorOrange
borderStylesolid
titleUtilizationStatement/base64 - Retorna o pdf do extrato de utilização do beneficiário

Retorna o pdf do Extrato de Utilização do beneficiário informado em base 64.

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/utilizationStatement/base64

GET

Nota
Expandir
titleParameters
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
subscriberId (path)stringMatricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)*required
date-of
dateOf (query)DateDe Ano /Mês/Dia de referência da declaração

*required

until-date

Se o semester não for informado

untilDate (query)DateAté Ano /Mês/Dia de referência da declaração

*required

Se o semester não for informado

semester (query)string

Busca pelo semestre do ano informado.

Deve ser informado o seguinte formado S/YYYY. onde S pode ser 1 (primeiro semestre) e 2 (segundo semestre) e YYYY corresponde ao ano. Exemplo: 2/2023


Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
fileNamestringNome do arquivo em PDF
*required
filestringString do arquivo em base 64
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "fileName": "plsr022_20230616_183833.pdf",
	"file" : "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9L..."
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        }
    ]
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001A-406",
            "message": "Campo date-of não informado",
            "detailedMessage": "Não foi informado o campo date-of."
        },
        {
            "code": "E001A-406",
            "message": "Campo until-date não informado",
            "detailedMessage": "Não foi informado o campo unilt-date."
        }
    ]
}
Aviso
Expandir
title(400) - Extrato não disponível
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.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Extrato não disponível",
    "detailedMessage": "Não foi possível realizar a impressão do Extrato de Utilização. Verificar o período informado."
}
Aviso
Expandir
title(404) - Beneficiário não encontrado
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.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E003",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}
Aviso
Expandir
title(400) - Período informado não permitido
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.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E004",
    "message": "Período informado não permitido.",
    "detailedMessage": "Período permitido somente para o mesmo ano. EX: dE 01/01/2023 A 31/12/2023."
}
Aviso
Expandir
title(400) - Intervalo de dias não permitido
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.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E005",
    "message": "Intervalo de dias não permitido.",
    "detailedMessage": "Permitido somente intervalo de no máximo 180 dia(s)."
}

...