Pular para o conteúdo principal

Integração por API

A API de integração permite que o sistema da empresa (ERP, TMS) emita e acompanhe autorizações, mantenha viagens, motoristas, veículos e postos e leia os catálogos, sem usar o portal.

Esta seção é para a equipe de TI da empresa.

Primeiros passos​

  1. O administrador da empresa habilita a integração e copia o token em Minha empresa.
  2. Envie o token em todas as chamadas, no cabeçalho Authorization: Bearer <token>.
  3. Experimente as chamadas no Swagger do ambiente (/swagger): informe o token em Authorize e teste.
  4. Leia o Guia da API para o formato das respostas, os identificadores e todos os recursos.

O que a API faz​

RecursoPara quê
AutorizaçõesRegistrar, consultar, cancelar e acompanhar autorizações; filas e confirmação de leitura
ViagensCriar e acompanhar viagens e as autorizações delas
Motoristas e veículosManter os cadastros e os vínculos com a empresa
PostosConsultar e vincular postos
UsuáriosManter usuários da empresa
CatálogosProdutos, marcas, modelos e demais tabelas de apoio
A empresa é sempre a do token

Nenhuma chamada recebe o identificador da empresa. Uma autorização, viagem ou cadastro de outra empresa responde como não localizado.