Base de informações da plataforma > Integração através de API (REST)

Utilização dos serviços de integração pela API (REST)

RTSYSINF.RQ-014

Descrição

O acesso ao sistema pode ser realizado através de uma API utilizando o protocolo REST.

Fluxo normal

Autenticação

A API utiliza autenticação Bearer. Solicite o token de acesso ao administrador do sistema e inclua o seguinte header no cabeçalho de todas as requisições. Exemplo: 
Authorization: Bearer 033CC53E52AB68451304CB751BC9D476D25789AC

Respostas

Todos os métodos executados com sucesso irão retornar status 200.
StatusDescrição
200 Método executado com sucesso
400 Serviço (objeto) inválido
401 Falha na autorização (token inválido)
404 Registro não encontrado
500 Erro interno (não esperado)

Erros, quando ocorrerem serão acompanhados de uma mensagem JSON contendo a descrição do erro:
Exemplo: 
{
   "error": "Usuário inválido!"
}

Métodos

Os seguintes métodos são suportados.

GET objeto/?query

Consulta uma lista de registros. Caso informado, a lista é obedece aos filtros informados. O retorno é formado por um array de objetos JSON.

O filtro deverá ser informado com os parâmetros documentados para o objeto específico.
Além de poder filtrar por um valor específico, também é possível filtrar por alguns operadores conforme a tabela abaixo. Os operadores são informados entre colchetes junto ao nome do campo a ser filtrado e quando o operador exigir mais do que um valor, então os valores deverão ser separados por ";".

Operador Descrição Exemplo
equals Filtra registros cujo campo tem um valor específico situacao=P
between Filtra registros cujo campo esteja em uma faixa data[between]=2018-01-01;2018-12-31
contains Filtra registros que possuam determinadas palavras no campodescricao[contains]=roda;pneu
not-equalsFiltra registros cujo campo tenha um valor diferente situacao[not-equals]=CANCELADO
in Campo tem um dos valores informados estabelecimento[in]=MATRIZ;FILIAL
not-in Campo não é um dos valores informados situacao[not-in]=P;E;X
is-null Campo deve estar nulo data_emissao[is-null]
is-not-nullCampo deve estar nulo data_emissao[is-not-null]

GET objeto/${id}

Retorna as informações de um objeto/registro específico.

DELETE objeto/${id}

Exclui o registro informado.

POST objeto

Cria um novo registro. Retorna os dados do registro tal qual ficou no base.

PUT objeto/${id}

Altera um registro.
Deverá ser enviado um JSON contendo apenas os atributos que dever ser alterados.