Główną funkcją interfejsu API obiektu (Object API) jest dostarczenie podstawowych informacji o jednym lub wielu obiektach klientów Object API jest w stanie obsłużyć zapytanie dotyczące wskazanego obiektu, a w przypadku, gdy nie wskazano pojedynczego obiektu, zwrócić wszystkie istniejące obiekty klientów
Przykład żądania API dla wskazanego obiektu:
GET /objects/{object_id}?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Aby ten interfejs API działał, wymagane są dwa parametry (nie licząc 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 } } |
Przykład żądania API dla wszystkich obiektów klientów:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Aby ten interfejs API działał, wymagane jest jedynie jeden parametr (nie licząc API_key):
| Parameter | Type | Description |
|---|---|---|
| version | String | Version of the API, currently only version=1 is available |
| api_key | String | User identification key |
Odpowiedź z serwera jest identyczna jak w przypadku odpowiedzi dla jednego obiektu, z wyjątkiem tego, że lista jest kontynuowana dla każdego z obiektów klientów.
Poniższa tabela przedstawia wszystkie pola odpowiedzi, które mogę być otrzymane dla każdego rodzaju parametru:
| 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 |
Punkty końcowe interfejsu API, parametry żądania i komunikaty zwrotne można przeglądać przy pomocy edytora „Swagger” za pośrednictwem: https://api.fm-track.com