FAQ: Partner API Methods

5.7.2024 | Veranika Patachyts

What is the Partner API?

The GPS-Trace Partner API is a powerful tool that enables businesses to integrate advanced GPS tracking capabilities into their existing systems. It offers a variety of methods for creating and managing user accounts and client plans, and configuration units, and generating custom reports and even download statistics.

How do I authenticate my requests to the Partner API?

The Partner API utilizes API token authentication to ensure secure access. You need to generate an API token from your account, which you will then use to authenticate all your requests.

What are the key features of the Partner API?

Key features of the GPS-Trace API include:

  • Account management
  • Company management
  • Client's plans management
  • Units management
  • User management
  • Billing management

Partner platform

How can I manage users with the Partner API?

The Partner API provides endpoints for user registration and management. You can create new user accounts, update user information, and manage client plans and sets of modules and permissions to ensure a secure and organized user base.

How does account management work?

The account CRUD subsection covers methods related to CRUD (Create, Read, Update, Delete) operations for accounts, which includes:

  • Creating accounts: Methods to create new accounts in the system.
  • Deleting accounts: Methods to remove accounts from the system.
  • Updating accounts: Methods to update existing account information.
  • Retrieving account information: Methods to fetch details of specific accounts.

When creating a client account, an application is assigned to the account, granting the client access. This is implemented through a request, with one of the mandatory fields being "reg_apps". IDs of applications include:

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

User entities are created simultaneously with the creation of a client account and are initially inactive. 

To activate the account:

  • the partner sends a special activation link to their client.
  • Upon clicking the activation link, the client enters his/her unique email address (to be associated with the account) and a password.
  • The client then receives a registration confirmation email at the provided address. By following the link in the email, the client completes the registration process by entering the requested information in the form, which could include password, login key, etc.

As a result, you create a new user with the help of our API in just a few clicks.

Is it a Partner API or an API for GPS monitoring?

It’s definitely a partner API based on the functionality of our Partner Panel. You cannot monitor your fleet via it. The main target is handling and customizing client accounts and units, establishing tariffs, managing analytics, and history. Using our API, you can integrate our partner platform with your CRM and billing system.

GPS Partner API Documentation

How can it benefit my business?

The Partner API simplifies various operational aspects, such as vehicle management, asset tracking, and data reporting. By automating these processes, businesses can reduce manual effort and increase profitability with ease.

Can I access historical tracking data using the Partner API?

Yes, the GPS-Trace Partner API enables access to historical tracking data.
This data is valuable for analyzing performance, investigating incidents, and optimizing future operations. For instance, you can use the GET /partner/units/{id}/messages(Get Unit Messages) method to retrieve messages from a device (unit) on Forguard. The maximum number of messages that can be retrieved is 10,000, and you can also specify the number of recent messages you want to obtain.

Example request to get the last 10 messages:

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

The fields in the response will depend on the parameters sent by the tracker.

How can custom reporting help my business?

Custom reporting allows you to generate detailed reports based on your specific needs.
These reports can include data on vehicle usage and efficiency, providing valuable insights for decision-making and improving business strategies. For instance, to get the latest unit telemetry data, you should use the GET /partner/units/{id}/telemetry” (Get Telemetry Data) method.

Example request:

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

As a result, you will download a report with the latest telemetry message of each device you specified.

How can I get started with the Partner API?

To get started with the Partner API, you can fill in the form at our website or write to us at business@gps-trace.com