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
- O administrador da empresa habilita a integração e copia o token em Minha empresa.
- Envie o token em todas as chamadas, no cabeçalho
Authorization: Bearer <token>. - Experimente as chamadas no Swagger do ambiente (
/swagger): informe o token em Authorize e teste. - Leia o Guia da API para o formato das respostas, os identificadores e todos os recursos.
O que a API faz
| Recurso | Para quê |
|---|---|
| Autorizações | Registrar, consultar, cancelar e acompanhar autorizações; filas e confirmação de leitura |
| Viagens | Criar e acompanhar viagens e as autorizações delas |
| Motoristas e veículos | Manter os cadastros e os vínculos com a empresa |
| Postos | Consultar e vincular postos |
| Usuários | Manter usuários da empresa |
| Catálogos | Produtos, 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.