Účelom tejto funkcie je poskytnúť základnú informáciu o jednom alebo všetkých objektoch klienta. Objekt API môže byť požadovaný buď pre jeden konkrétny objekt alebo, ak nie je žiadny objekt špecifikovaný, API vráti všetky existujúce objekty klienta.
Príklad požiadavke API pre konkrétny objekt:
GET /objects/{object_id}?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Aby toto API fungovalo, sú povinné dva parametre (mimo API_key):
| 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 |
1 2 3 4 5 6 7 8 9 10 | { "id" : "abc123", "name" : "AAA 000", "imei" : 123456789123, "vehicle_params" : { "vin" : null, "make" : null, "model" : null } } |
Príklad požiadavke API pre všetky objekty klienta:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Pre toto API je povinný jeden parameter (mimo API_key):
| Parameter | Type | Description |
|---|---|---|
| version | String | Version of the API, currently only version=1 is available |
| api_key | String | User identification key |
Odpoveď servera je identická odpovede pre jeden objekt, s tým, že sa jedná o všetky objekty.
Všetky zodpovední polia, ktoré môžu byť doručená s každým typom parametra sú popísané v nasledujúcej tabuľke:
| 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 |
Koncové body API, parametre požiadaviek a odpovede sú k nahliadnutiu v “Swagger” prostredníctvom tohto odkazu: https://api.fm-track.com