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	UnreferencedNetworks - Retorna as redes não referenciadas

Retorna as redes não referenciadas cadastradas no sistema

/totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworks

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 redes não referenciadas pelo código no sistema (BK6_CODIGO)
name (query)	string	Filtro de redes não referenciadas pelo nome (BK6_NOME)
identifier (query)	string	Filtro de redes não referenciadas pelo CPF/CNPJ (BK6_CGC)
council (query)	string	Filtro de redes não referenciadas pela sigla do conselho regional (BK6_SIGLA)
council-number councilNumber (query)	string	Filtro de redes não referenciadas pelo numero do conselho regional (BK6_CONREG)
council-state-abbreviation councilStateAbbreviation (query)	string	Filtro de redes não referenciadas pelo estado do conselho regional (BK6_ESTCR)
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 conselhos regionais
items.code	string	Código da rede não referenciada no sistema	BK6_CODIGO	*required
items.name	string	Nome da rede não referenciada	BK6_NOME
items.council	string	Sigla do conselho regional da rede não referenciada	BK6_SIGLA
items.council-_number	string	Numero do conselho regional da rede não referenciada	BK6_CONREG
items.council-_state-_abbreviation	string	Estado do conselho regional da rede não referenciada	BK6_ESTCR
items.identifier	string	CPF/CNPJ da rede não referenciada	BK6_CGC
items.city-_code	string	Código do município da rede não referenciada	BK6_MUNCR
items.city-_code-_residence	string	Descrição do município	BID_DESCRI

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "code": "000001",
            "name": "TESTERS",
            "council": "CRM",
            "council-_number": "14569877",
            "council-_state-_abbreviation": "",
            "identifier": "62996640000150",
            "city-_code": "",
            "city-_code-_residence": ""
        },
        {
            "code": "000002",
            "name": "ADGREGETHGT",
            "council": "",
            "council-_number": "",
            "council-_state-_abbreviation": "",
            "identifier": "90846127000119",
            "city-_code": "",
            "city-_code-_residence": ""
        },
        {
            "code": "000002",
            "name": "PRESTADOR DE DIFERENTE VALOR",
            "council": "",
            "council-number": "",
            "council-state-abbreviation": "",
            "identifier": "57522658322463",
            "city-code": "",
            "city-code-residence": ""
        },
        {
            "code": "000002",
            "name": "JOSE",
            "council": "",
            "council-number": "",
            "council-state-abbreviation": "SP",
            "identifier": "77077733000159",
            "city-code": "3500105",
            "city-code-residence": "ADAMANTINA"
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO