Получение информации об объекте

Этот API используется для получения полной информации о транспортном средстве.
Можно запросить данные как по agent_id, так и по IMEI-номеру устройства.
В ответе возвращается подробная информация: госномер, расход топлива, лимиты скорости, VIN, модель, настройки конфигурации, привязанный водитель и прочее.

Как получить данные

Метод

GET

Адрес запроса

Для получения данных используйте адрес: https://<server_address>/backend/api.php?

Параметры запроса

Обязательные:
  • cmd=vehinfo — команда для получения информации о ТС
  • node — номер узла, на котором нужно выполнить команду
Один из этих параметров должен быть указан:
  • agentid — идентификатор машины (agent_id)
  • imei — уникальный IMEI-номер устройства
     

Пример запроса

https://<server_address>/backend/api.php?cmd=vehinfo&agentid=81181&node=1
Ответ
[
  {
    "ownerid": 5374,
    "vehiclenumber": "Howen C",
    "typeid": 1,
    "summer_fuel": "10",
    "winter_fuel": "10",
    "idle_fuel": "2",
    "time_zone": "Europe/Moscow",
    "speed_limit": 0,
    "agentid": 81181,
    "account_id": 3925,
    "model": "",
    "year": "1900",
    "vin": "",
    "fuel_type": "50",
    "driver_name": "Test",
    "driver_phone": "12121212121"
  }
]
 
В ответ на API-запрос возвращается:
  • ownerid — ID владельца
  • vehiclenumber — госномер или название ТС
  • typeid — тип транспортного средства
  • summer_fuel / winter_fuel / idle_fuel — нормы расхода топлива (лето, зима, холостой ход)
  • time_zone — часовой пояс, в котором используется ТС
  • speed_limit — ограничение скорости
  • account_id — ID договора, к которому привязано ТС
  • model / year / vin — модель, год выпуска и VIN автомобиля
  • fuel_type — тип топлива
  • driver_name / driver_phone — ФИО и телефон закрепленного водителя
  • config — JSON с дополнительной конфигурацией (настройки по топливу, мотор-часам, ограничениям и др.)