What is the GPS-Trace Platform API?
The Platform API is a software interface for registered GPS-Trace Console users. It allows external systems, such as CRM, billing, or reporting tools, to request GPS-Trace data and perform selected Console operations.
The API includes methods for working with users, client plans, units, billing data, statistics, and reports.
How do I authenticate API requests?
API requests are authenticated with an API token. A token is an access key generated in GPS-Trace Console. It must be included in each request so the platform can check which actions are allowed for the user.
The token is sent in the X-AccessToken request header.
What API method groups are available?
The API includes the following method groups:
- Account data methods
- Company data methods
- Client plan methods
- Unit methods
- User methods
- Billing data methods
- Statistics and report methods
How can I work with users through the API?
The Platform API provides methods for working with users. Depending on the available permissions, Console users can create user records, update user data, and assign client plans, modules, and permissions.
How do account data methods work?
The account section includes methods for creating, reading, updating, and deleting account data. These actions are often referred to as CRUD operations.
- Create an account
- Delete an account
- Update account data
- Retrieve account data
When a client account is created, the request can include the application that should be assigned to the account. This is done through the reg_apps field. The available applications depend on the user’s access level and agreement terms.
User records are created together with the client account and are inactive until the activation process is completed.
To activate the account:
- The Console user sends an activation link to the client.
- The client follows the link and enters an email address and password.
- The client confirms registration through the email confirmation link.
- After confirmation, the user account becomes active according to the assigned application, plan, and permissions.
Is this API used for tracking vehicles directly?
The API is intended for GPS-Trace Console operations and data exchange with external systems. It is not a replacement for the Forguard mobile application or other GPS-Trace tracking interfaces.
Console users can apply the API to work with units, client plans, statistics, history, CRM systems, and billing systems, depending on their access level.
What can the API be used for?
The Platform API can be used to connect GPS-Trace with CRM, billing, reporting, or internal systems.
For example, Console users can retrieve unit data, work with client plans, export statistics, and reduce repeated manual actions in external workflows.
Can I access historical tracking data through the API?
Yes, the Platform API can provide access to historical tracking data, depending on the available methods and permissions.
For example, the GET /partner/units/{id}/messages method retrieves messages from a unit. The maximum number of messages that can be retrieved is 10,000. You can also specify the number of recent messages you want to receive.
Example request to get the last 10 messages:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/json' \
-H 'X-AccessToken: '
The fields in the response depend on the parameters sent by the tracking device.
How can I retrieve telemetry data?
To get the latest telemetry data for a unit, use the GET /partner/units/{id}/telemetry method. The response contains the latest telemetry message available for the specified unit. The exact fields depend on the data sent by the tracking device.
Example request:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/json' \
-H 'X-AccessToken: '
How can I get started with the API?
To request API access, just sign into your Console account. If you don't have it, you may sign up here as well.