API de Web Services – Visão Geral e Primeiros Passos
A API de Web Services do TripLog permite-lhe integrar os dados do TripLog diretamente nos seus próprios sistemas. Utilize-a para obter registos de viagens, gerir utilizadores, obter dados de despesas e muito mais — tudo através de pedidos HTTP padrão e JSON.
Quem pode utilizá-la: A API está disponível para subscritores do plano Enterprise. O acesso à API é gerido ao nível da organização por um administrador Primary.
URL Base
Todos os pedidos da API são efetuados para:
https://app.triplog.net/web/api/
Autenticação
Cada pedido deve incluir a chave de API da sua organização no cabeçalho Authorization:
Authorization: apikey YOUR_API_KEY
Para gerar ou obter a sua chave de API, consulte Como Gerar a Chave de API.
Mantenha a sua chave de API segura. Esta concede acesso total de leitura/escrita aos dados da sua organização. Não a exponha em código do lado do cliente nem em repositórios públicos.
Formato do Pedido
Protocolo: Apenas HTTPS
Método: GET ou POST, consoante o endpoint (indicado em cada artigo)
Content-Type:
application/jsonpara pedidos POST com corpo de pedidoFormato da resposta: JSON
Tamanho da Resposta
Os endpoints que devolvem listas (como /trips e /users) devolvem todos os registos correspondentes numa única resposta — não existe paginação. Para organizações com grandes volumes de dados, isto pode resultar em payloads muito grandes.
Para manter o tamanho das respostas controlável:
Utilize os parâmetros de intervalo de datas disponíveis para delimitar a sua consulta (por exemplo,
startDate/endDateno endpoint Trips)Evite consultas sem filtros, a menos que pretenda uma exportação completa dos dados
Códigos de Estado HTTP
Código | Significado |
| Sucesso |
| Pedido inválido — verifique os seus parâmetros |
| Não autorizado — chave de API em falta ou inválida |
| Proibido — o seu plano não inclui acesso à API |
| Recurso não encontrado |
| Erro do servidor — tente novamente após um curto período |
Endpoints Disponíveis
Endpoint | Descrição |
Listar e gerir utilizadores da sua organização | |
Localização em tempo real de um utilizador | |
Obter registos de viagens com filtragem por utilizador e data | |
Obter pontos de referência GPS de uma viagem específica | |
Gestão de Aprovação de Viagens | |
Estatísticas de quilometragem por utilizador ou período | |
Gestão de Localizações de Utilizadores | |
Registos de veículos da sua organização | |
Registos de despesas | |
Gestão de Aprovação de Despesas | |
Imagens e metadados de recibos | |
Criar e gerir etiquetas personalizadas para viagens e despesas | |
Aceder ao registo de auditoria dos registos de aprovação | |
Registos de controlo de tempo por utilizador e intervalo de datas | |
Quilometragem discriminada por estado dos EUA |