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

02. EXEMPLO DE UTILIZAÇÃO

...

Painel

titleColor	Orange
borderStyle	solid
title	cities - Retorna os municípios

Retorna os municípios (cidades) cadastrados no sistema.

/totvsHealthPlans/locality/v1/cities

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
cityCode (query)	string	Filtro de municípios pelo código IBGE
cityDescription (query)	string	Filtro de municípios pela nome/descrição
stateAbbreviation (query)	string	Filtro de municípios pelo estado
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 municípios
items.cityCodecity_code	string	Código IBGE do município	BID_CODMUN	*required
items.cityDescriptioncity_description	string	Nome do município	BID_DESCRI	*required
items.stateAbbreviationstate_abbreviation	string	UF do estado do município	BID_EST	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "cityCodecity_code": "2300101",
            "cityDescriptioncity_description": "ABAIARA",
            "stateAbbreviationstate_abbreviation": "CE"
        },
        {
            "cityCodecity_code": "2300150",
            "cityDescriptioncity_description": "ACARAPE",
            "stateAbbreviationstate_abbreviation": "CE"
        },
        {
            "cityCodecity_code": "2300200",
            "cityDescriptioncity_description": "ACARAU",
            "stateAbbreviationstate_abbreviation": "CE"
        }
    ],
    "hasNext": true,
    "remainingRecords": 363
}

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO