Histórico da Página

...

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	documents - Retorna os documentos do reembolso

Retorna os documentos (Tipos de comprovantes) utilizado na solicitação de reembolso do beneficiário.

/totvsHealthPlans/refundSetup/v1/documents

GET

Nota

Expandir

title	Parameters

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
code (query)	string	Filtro de documentos pelo código
description (query)	string	Filtro de documento pela descrição
required (query)	string	Filtro de documentos por obrigatoriedade
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
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

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de documentos de reembolso
items.code	string	Código do documento no sistema	BBS_COD	*required
items.description	string	Descrição do documento	BBS_DESCRI	*required
items.image-_href	string	Caminho no servidor da imagem vinculada ao documento.	BBS_IMG
items.required	string	Indica se o documento é obrigatório na solicitação de reembolso, sendo: 0 - Não 1 - Sim	BBS_OBRIGA	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "code": "01",
            "description": "CNPJ",
            "image-_href": "",
            "required": "1"
        },
        {
            "code": "02",
            "description": "NOTA FISCAL",
            "image-_href": "",
            "required": "1"
        },
        {
            "code": "03",
            "description": "RECIBO",
            "image-_href": "",
            "required": "1"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO