Skip to main content
Este guia mostra como realizar sua primeira integração com a API iGps, desde a autenticação até uma chamada prática a um dos endpoints disponíveis. Como exemplo, vamos consultar a posição mais recente de veículos utilizando seus números de chassi. Depois de concluir este processo, você poderá utilizar o mesmo modelo de autenticação para consumir os demais recursos da API, como clientes, veículos, dispositivos, vínculos de rastreadores, comandos, cadastros e integrações operacionais ou administrativas.
1

Obtenha Suas Credenciais

Para consumir a API iGps, sua aplicação precisa de um client_id e um client_secret válidos.Essas credenciais identificam sua integração e são utilizadas para gerar o token de acesso necessário para realizar chamadas aos endpoints da API.
Mantenha seu client_secret protegido e nunca o exponha em aplicações públicas, código frontend ou repositórios de código.
2

Obtenha um Token de Acesso

Envie seu client_id e client_secret em uma requisição POST para /api/v1/auth/token.
Uma autenticação bem-sucedida retorna um token Bearer e seu tempo de expiração:
Utilize o valor de access_token no cabeçalho Authorization das próximas requisições:
3

Faça Sua Primeira Requisição

Com o token de acesso, você já pode consumir os endpoints liberados para sua integração.Neste exemplo, vamos consultar a posição mais recente de veículos por meio do endpoint /api/v1/veiculos/posicoes.Envie uma requisição POST contendo os números de chassi dos veículos que deseja consultar. Este endpoint permite consultar até 50 veículos em uma única requisição.
4

Proces​se a Resposta

A API retorna o resultado correspondente a cada veículo informado na requisição.
Cada entrada em resultados possui um campo status que permite identificar o resultado da consulta:
  • ok: o veículo foi localizado e os dados de posição estão disponíveis.
  • nao_encontrado: não foi encontrada uma posição para o chassi informado.
Exemplo de processamento em Python:
5

Explore os Demais Recursos

O processo de autenticação é o mesmo para os demais endpoints disponíveis na sua integração.A partir daqui, sua aplicação poderá utilizar os recursos liberados para, por exemplo:
  • cadastrar e consultar clientes;
  • cadastrar e consultar veículos;
  • cadastrar e consultar dispositivos;
  • realizar vínculos entre rastreadores e veículos;
  • consultar marcas e modelos de veículos;
  • consultar posições e informações de rastreamento;
  • enviar comandos aos dispositivos;
  • receber retornos e eventos por callbacks ou webhooks;
  • integrar sistemas financeiros, administrativos e de cobrança;
  • conectar ERPs, plataformas próprias e sistemas de parceiros.
Consulte a Referência da API para conhecer os endpoints, parâmetros e exemplos disponíveis para cada recurso.
Substitua YOUR_CLIENT_ID, YOUR_CLIENT_SECRET, YOUR_ACCESS_TOKEN e os números de chassi pelos valores correspondentes à sua integração.
A API iGps utiliza endpoints REST e payloads JSON padrão. Nenhum SDK proprietário é necessário: você pode realizar a integração utilizando qualquer linguagem de programação ou cliente HTTP compatível.