FAQ: Métodos da API de Parceiros

O que é a API de Parceiros?

A API de Parceiros GPS-Trace é uma ferramenta poderosa que permite às empresas integrar capacidades avançadas de rastreamento GPS em seus sistemas existentes. Ela oferece uma variedade de métodos para criar e gerenciar contas de usuários e planos de clientes, configurar unidades e gerar relatórios personalizados e até mesmo baixar estatísticas.

Como autentico minhas solicitações para a API de Parceiros?

A API de Parceiros utiliza autenticação por token de API para garantir acesso seguro. Você precisa gerar um token de API a partir da sua conta, que será usado para autenticar todas as suas solicitações.

Quais são os principais recursos da API de Parceiros?

Os principais recursos da API GPS-Trace incluem:

• Gerenciamento de contas
• Gerenciamento de empresas
• Gerenciamento de planos de clientes
• Gerenciamento de unidades
• Gerenciamento de usuários
• Gerenciamento de faturamento

Como posso gerenciar usuários com a API de Parceiros?

A API de Parceiros fornece endpoints para registro e gerenciamento de usuários. Você pode criar novas contas de usuário, atualizar informações de usuários e gerenciar planos de clientes e conjuntos de módulos e permissões para garantir uma base de usuários segura e organizada.

Como funciona o gerenciamento de contas?

A subseção CRUD de contas cobre métodos relacionados às operações CRUD (Criar, Ler, Atualizar, Excluir) para contas, que incluem:

• Criar contas: Métodos para criar novas contas no sistema.
• Excluir contas: Métodos para remover contas do sistema.
• Atualizar contas: Métodos para atualizar informações de contas existentes.
• Recuperar informações de contas: Métodos para buscar detalhes de contas específicas.

Ao criar uma conta de cliente, um aplicativo é atribuído à conta, concedendo acesso ao cliente. Isso é implementado por meio de uma solicitação, com um dos campos obrigatórios sendo "reg_apps". IDs de aplicativos incluem:

• Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
• Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
• Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Entidades de usuário são criadas simultaneamente com a criação de uma conta de cliente e são inicialmente inativas. 

Para ativar a conta:

• o parceiro envia um link de ativação especial para seu cliente.
• Ao clicar no link de ativação, o cliente insere seu endereço de e-mail exclusivo (a ser associado à conta) e uma senha.
• O cliente então recebe um e-mail de confirmação de registro no endereço fornecido. Ao seguir o link no e-mail, o cliente completa o processo de registro inserindo as informações solicitadas no formulário, que podem incluir senha, chave de login, etc.

Como resultado, você cria um novo usuário com a ajuda da nossa API em apenas alguns cliques.

É uma API de Parceiros ou uma API para monitoramento GPS?

É definitivamente uma API de parceiros baseada na funcionalidade do nosso Painel de Parceiros. Você não pode monitorar sua frota através dela. O principal objetivo é lidar e personalizar contas de clientes e unidades, estabelecer tarifas, gerenciar análises e histórico. Usando nossa API, você pode integrar nossa plataforma de parceiros com seu sistema CRM e de faturamento.

Como isso pode beneficiar meu negócio?

A API de Parceiros simplifica vários aspectos operacionais, como gerenciamento de veículos, rastreamento de ativos e relatórios de dados. Automatizando esses processos, as empresas podem reduzir o esforço manual e aumentar a lucratividade com facilidade.

Posso acessar dados de rastreamento históricos usando a API de Parceiros?

Sim, a API de Parceiros GPS-Trace permite acesso a dados de rastreamento históricos.
Esses dados são valiosos para analisar desempenho, investigar incidentes e otimizar operações futuras. Por exemplo, você pode usar o “GET /partner/units/{id}/messages“ (Obter Mensagens da Unidade) para recuperar mensagens de um dispositivo (unidade) no Forguard. O número máximo de mensagens que podem ser recuperadas é 10.000, e você também pode especificar o número de mensagens recentes que deseja obter.

Exemplo de solicitação para obter as últimas 10 mensagens:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Os campos na resposta dependerão dos parâmetros enviados pelo rastreador.

Como a criação de relatórios personalizados pode ajudar meu negócio?

A criação de relatórios personalizados permite gerar relatórios detalhados com base em suas necessidades específicas.
Esses relatórios podem incluir dados sobre uso e eficiência de veículos, fornecendo insights valiosos para a tomada de decisões e melhoria de estratégias empresariais. Por exemplo, para obter os dados de telemetria mais recentes da unidade, você deve usar o “GET /partner/units/{id}/telemetry” (Obter Dados de Telemetria).

Exemplo de solicitação:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Como resultado, você baixará um relatório com a mensagem de telemetria mais recente de cada dispositivo especificado.

Como posso começar a usar a API de Parceiros?

Para começar a usar a API de Parceiros, você pode preencher o formulário em nosso site ou escrever para nós em business@gps-trace.com