API | GPS-Trace

API

Welcome to the API Documentation!

GPS-Trace is a leading provider of GPS tracking solutions with 20 years of experience in developing applications for the telematics industry.

Our platform is suitable for service providers and small businesses in the following sectors:

  • GPS Equipment Sales and Installation
  • Logistics and Transportation
  • Security and Monitoring Services
  • Vehicle Rentals and Maintenance
  • And more

GPS-Trace platform provides a diverse range of features that seamlessly process data from GPS trackers.
We focus on quick setup and ease of use.

Business Solutions:

  • Partner Panel: This is a comprehensive tool tailored for our dealers, enabling seamless business management.
    Partner Panel provides service providers with the ability to create client accounts with access to applications like Forguard, Ruhavik, and Petovik. They can create units within these accounts, link trackers to them, establish tariffs, access analytics, provide client support, and more.
    When clients activate their Ruhavik and Petovik accounts, they gain ownership, allowing dealers partial access only if the client enables Service mode in the application.
  • Forguard: Vehicle tracking application distributed solely through our dealer network and doesn't have open registration.
    Forguard solution providesservice providers with full control over clients' accounts.
    Dealers can set limits, customize modules, and manage client accounts using custom Client Plans. They have access to client accounts at any time, enabling them to configure application design, logos, automatic account locking, and more.
    Forguard's flexible billing system operates on a per-unit per day payment basis, allowing dealers to manage billing efficiently.

For personal use (apps with open registration):

  • Ruhavik: A user-friendly application developed for vehicle tracking.
  • Petovik: An application designed for pets tracking.

If you're selling GPS devices or offering telematic services, GPS-Trace provides an intuitive app with over 2000 supported device types and essential features.

API lets dealers do a bunch of things easily, just like they can in the Partner Panel:

  • Create client accounts with access to applications like Forguard, Ruhavik, and Petovik.
  • Set up automatic account locks or block accounts
  • Get login links for client accounts.
  • Create units in client accounts.
  • Check stats for accounts and units.
  • Plus more: There are lots of other things service providers can do with API to manage their business smoothly.

To start using the Platform API, the first step is to gain access to the Partner Panel.
Once you have access, the next step is to obtain an authorization token. This token can be obtained within the Partner Panel itself, specifically on the Tokens tab.

This token is essential for API usage, as it must be included in the "X-AccessToken" header of every request to authenticate the user's identity. For more detailed information about obtaining and using the authorization token, please refer to the "Authorization Token" section.

HTTP Status Codes

The following table provides information about the various HTTP status codes that the API might return.
Each status code indicates the result of the requested operation and helps in identifying the type of response or error encountered.

Code HTTP Status Description
OK 200 Successful operation
CREATED 201 Successful operation upon creation
FAILED_VALIDATION 400 Validation for this particular item failed
INVALID_PAYLOAD 400 Provided payload is invalid
INVALID_QUERY 400 The requested query parameters cannot be used
FORBIDDEN 403 You are not allowed to perform the current action
INVALID_TOKEN 403 Provided token is invalid
TOKEN_EXPIRED 401 Provided token is valid but has expired
ROUTE_NOT_FOUND 404 Endpoint does not exist
SERVICE_UNAVAILABLE 503 Could not use external service
INTERNAL_SERVER_ERROR 500 The server encountered an unexpected condition

 

We hope this documentation helps you navigate and utilize the GPS-Trace platform effectively. If you have any questions or need assistance, please don't hesitate to reach out to our team.
Happy tracking!