Object APIs main purpose is to provide basic information about one or all clients objects. Object API can request either for one specific object, or if no objects are specified, the API will return clients’ all existing objects.
API request example for a specific object:
GET /objects/{object_id}?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
For this API to work, two parameters (not counting the API_key) are mandatory:
Parameter | Type | Description |
---|---|---|
objectId | String | Object identifier (This ID can be acquired by sending and API request for clients all available objects) |
version | String | Version of the API, currently only version=1 is available |
api_key | String | User identification key |
{ "id": "abc123", "name": "AAA 000", "imei": "123456789123", "vehicle_params": { "vin": null, "make": null, "model": null, "plate_number": null } }
If a parameter was entered incorrectly, the system will respond with an error code. All error codes are described in the APIs section. Parameters for which no data is provided are not included in the response. A full list of response parameters is available at the end of this section.
API request example for all clients objects:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
For this API to work, only one parameter (not counting the API_key) is mandatory:
Parameter | Type | Description |
---|---|---|
version | String | Version of the API, currently only version=1 is available |
api_key | String | User identification key |
Response from server is identical to the response for one object, except the list continues for every one of the clients objects.
All response fields than can be received with every type of parameter are described in the next table:
Name | Type | Description |
---|---|---|
name | String | Visible vehicle name |
imei | String | Vehicle hardware IMEI code |
make | String | Vehicle brand |
model | String | Vehicle brand model |
object_id | String | Object identifier (external) |
vin | String | VIN of object |
plate_number | String | Plate number of object |
API endpoints, request parameters and responses can be previewed in “Swagger” through this link : https://api.fm-track.com