Účelem této funkce je poskytnout základní informaci o jednom nebo všech objektech klienta. Objekt API může být požadován buď pro jeden konkrétní objekt nebo, jestliže není žádný objekt specifikován, API vrátí všechny existující objekty klienta.
Příklad požadavku API pro konkrétní 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, jsou povinné dva parametry (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 } } |
Příklad požadavku API pro všechny objekty klienta:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Pro toto API je povinný jeden parametr (mimo API_key):
| Parameter | Type | Description |
|---|---|---|
| version | String | Version of the API, currently only version=1 is available |
| api_key | String | User identification key |
Odpověď serveru je identická odpovědi pro jeden objekt, s tím, že se jedná o všechny objekty.
Všechna odpovědní pole, jež mohou být obdržena s každým typem parametru jsou popsána v následující tabulce:
| 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, parametry požadavků a odpovědi jsou k nahlédnutí v “Swagger” prostřednictvím tohoto odkazu: https://api.fm-track.com