Основная цель API объекта – предоставлять основную информацию об одном или всех объектах пользователя. API объекта может отправлять запрос для одного конкретного объекта, либо если объект не указан, то API выдаст информацию о всех объектах пользователя.
Для работы данного API, необходимо только два параметра (не считая API ключ):
GET /objects/{object_id}?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Для работы данного API, необходимо только два параметра (не считая API ключ):
| Параметр | Тип | Пояснение |
|---|---|---|
| objectId | Строка | Идентификатор объекта (Данное ID может быть получено отправив API запрос сразу для всех объектов) |
| version | Строка | Версия API, в настоящее время только версия = 1 доступна |
| api_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 } } |
Пример запроса API для всех объектов пользователя:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Для работы данного API, необходимо только один параметр (не считая API ключ):
| Параметр | Тип | Пояснение |
|---|---|---|
| version | Строка | Версия API, в настоящее время только версия = 1 доступна |
| api_key | Строка | Ключ идентификации пользователя |
Ответ с сервера для нескольких объектов идентичен ответу для одного объекта, за исключением того что список продолжается для каждого из объектов пользователя.
Все поля ответа которые могут быть получены с каждым типом параметров описаны далее в таблице:
| Параметр | Тип | Пояснение |
|---|---|---|
| name | Строка | Видимое название транспортного средства |
| imei | Строка | IMEI код оборудования установленного в транспортном средстве |
| make | Строка | Производитель транспортного средства |
| model | Строка | Модель транспортного средства |
| object_id | Строка | Идентификатор объекта (наружный) |
| vin | Строка | VIN код объекта |
Конечные точки API, запрашиваемые параметры а также примеры ответов могут быть просмотрены в “Swagger” через данную ссылку: https://api.fm-track.com