O que é a GPS-Trace Platform API?
A Platform API é uma interface de software para usuários registrados do GPS-Trace Console. Ela permite que sistemas externos, como CRM, cobrança ou ferramentas de relatórios, solicitem dados do GPS-Trace e executem operações selecionadas do Console.
A API inclui métodos para trabalhar com usuários, planos do cliente, unidades, dados de cobrança, estatísticas e relatórios.
Como autentico as solicitações da API?
As solicitações da API são autenticadas com um token de API. Um token é uma chave de acesso gerada no GPS-Trace Console. Ele deve ser incluído em cada solicitação para que a plataforma possa verificar quais ações são permitidas para o usuário.
O token é enviado no cabeçalho de solicitação X-AccessToken.
Quais grupos de métodos da API estão disponíveis?
A API inclui os seguintes grupos de métodos:
- Métodos de dados da conta
- Métodos de dados da empresa
- Métodos de plano do cliente
- Métodos de unidade
- Métodos de usuário
- Métodos de dados de cobrança
- Métodos de estatísticas e relatórios
Como posso trabalhar com usuários pela API?
A Platform API oferece métodos para trabalhar com usuários. Dependendo das permissões disponíveis, os usuários do GPS-Trace Console podem criar registros de usuário, atualizar dados do usuário e atribuir planos do cliente, módulos e permissões.
Como funcionam os métodos de dados da conta?
A seção de conta inclui métodos para criar, ler, atualizar e excluir dados da conta. Essas ações são frequentemente chamadas de operações CRUD.
- Criar uma conta
- Excluir uma conta
- Atualizar dados da conta
- Recuperar dados da conta
Quando uma conta de cliente é criada, a solicitação pode incluir o aplicativo que deve ser atribuído à conta. Isso é feito por meio do campo reg_apps. Os aplicativos disponíveis dependem do nível de acesso do usuário e dos termos do acordo.
Os registros de usuário são criados junto com a conta do cliente e ficam inativos até que o processo de ativação seja concluído.
Para ativar a conta:
- O usuário do GPS-Trace Console envia um link de ativação ao cliente.
- O cliente acessa o link e informa um endereço de e-mail e uma senha.
- O cliente confirma o cadastro por meio do link de confirmação enviado por e-mail.
- Após a confirmação, a conta de usuário fica ativa conforme o aplicativo, o plano e as permissões atribuídos.
Esta API é usada para rastrear veículos diretamente?
A API é destinada a operações do GPS-Trace Console e à troca de dados com sistemas externos. Ela não substitui o aplicativo móvel Forguard nem outras interfaces de rastreamento do GPS-Trace.
Os usuários do GPS-Trace Console podem aplicar a API para trabalhar com unidades, planos do cliente, estatísticas, Histórico, sistemas de CRM e sistemas de cobrança, dependendo do nível de acesso.
Para que a API pode ser usada?
A Platform API pode ser usada para conectar o GPS-Trace a sistemas de CRM, cobrança, relatórios ou sistemas internos.
Por exemplo, os usuários do GPS-Trace Console podem recuperar dados de unidades, trabalhar com planos do cliente, exportar estatísticas e reduzir ações manuais repetidas em fluxos de trabalho externos.
Posso acessar dados históricos de rastreamento pela API?
Sim, a Platform API pode fornecer acesso a dados históricos de rastreamento, dependendo dos métodos e permissões disponíveis.
Por exemplo, o método GET /partner/units/{id}/messages recupera mensagens de uma unidade. O número máximo de mensagens que pode ser recuperado é 10.000. Você também pode especificar a quantidade de mensagens recentes que deseja receber.
Exemplo de solicitação para obter as últimas 10 mensagens:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Os campos na resposta dependem dos parâmetros enviados pelo dispositivo de rastreamento.
Como posso recuperar dados de telemetria?
Para obter os dados de telemetria mais recentes de uma unidade, use o método GET /partner/units/{id}/telemetry. A resposta contém a mensagem de telemetria mais recente disponível para a unidade especificada. Os campos exatos dependem dos dados enviados pelo dispositivo de rastreamento.
Exemplo de solicitação:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Como posso começar a usar a API?
Para solicitar acesso à API, basta entrar na sua conta do Console. Se você não tiver uma, também pode se cadastrar aqui.