API de Web Services – Visão Geral & Primeiros Passos
A API de Web Services do TripLog permite integrar os dados do TripLog diretamente aos seus próprios sistemas. Use-a para recuperar registros de viagens, gerenciar usuários, obter dados de despesas e muito mais — tudo por meio de requisições HTTP padrão e JSON.
Quem pode usar: A API está disponível para assinantes do plano Enterprise. O acesso à API é gerenciado no nível da organização por um administrador principal.
URL Base
Todas as requisições da API são feitas para:
https://app.triplog.net/web/api/
Autenticação
Toda requisição deve incluir a chave de API da sua organização no cabeçalho Authorization:
Authorization: apikey YOUR_API_KEY
Para gerar ou recuperar sua chave de API, consulte Como Gerar a Chave de API.
Mantenha sua chave de API em segurança. Ela concede acesso total de leitura e gravação aos dados da sua organização. Não a exponha em código do lado do cliente nem em repositórios públicos.
Formato da Requisição
Protocolo: somente HTTPS
Método: GET ou POST, dependendo do endpoint (indicado em cada artigo)
Content-Type:
application/jsonpara requisições POST com corpo de requisiçãoFormato da resposta: JSON
Tamanho da Resposta
Endpoints que retornam listas (como /trips e /users) retornam todos os registros correspondentes em uma única resposta — não há paginação. Para organizações com grandes conjuntos de dados, isso pode resultar em respostas muito grandes.
Para manter o tamanho das respostas gerenciável:
Use os parâmetros de intervalo de datas disponíveis para limitar sua consulta (p. ex.,
startDate/endDateno endpoint Trips)Evite consultar sem filtros, a menos que a intenção seja uma exportação completa de dados
Códigos de Status HTTP
Código | Significado |
| Sucesso |
| Requisição inválida — verifique seus parâmetros |
| Não autorizado — chave de API ausente ou inválida |
| Proibido — seu plano não inclui acesso à API |
| Recurso não encontrado |
| Erro do servidor — tente novamente após um breve intervalo |
Endpoints Disponíveis
Endpoint | Descrição |
Listar e gerenciar usuários da sua organização | |
Localização em tempo real de um usuário | |
Recuperar registros de viagens com filtro por usuário e data | |
Obter pontos de passagem GPS de uma viagem específica | |
Approval Management para viagens | |
Estatísticas de quilometragem por usuário ou período | |
Gerenciamento de Locais de usuários | |
Registros de veículos da sua organização | |
Registros de despesas | |
Approval Management para despesas | |
Imagens e metadados de recibos | |
Criar e gerenciar tags personalizadas para viagens e despesas | |
Acessar o log de auditoria dos registros de aprovação | |
Registros do módulo Registro de Tempo por usuário e intervalo de datas | |
Quilometragem detalhada por estado dos EUA |