Welcome to the GPS-Trace Platform API Documentation!
GPS-Trace is a telematics platform designed to meet the needs of both individual users and businesses.
Our software provides a diverse range of features that seamlessly process data from GPS trackers.
Whether you're tracking vehicles or monitoring pets, GPS-Trace has you covered.
Our platform offers several applications tailored to different user needs.
Business Solutions:
For personal use (apps with open registration):
Our partners include:
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.
The Platform API lets partners do a bunch of things easily, just like they can in the Partner Panel:
To start using the Platform API, the first step is to become our partner and 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!