Vehicle information

This API is used to retrieve detailed information about a vehicle.
You can request data either by agent_id or by the device’s IMEI number.
The response returns full details, including license plate, fuel consumption, speed limits, VIN, model, configuration settings, assigned driver, and more.

How to get data

Method

GET

Request address

To get the data, use the address: https://<server_address>/backend/api.php?

Request parameters

Required:
  • cmd=vehinfo — command to retrieve vehicle information
  • node — the number of the node where the command should be executed
One of these parameters must be specified:
  • agentid — vehicle identifier (agent_id)
  • imei — unique IMEI number of the device

Example request:

https://<server_address>/backend/api.php?cmd=vehinfo&agentid=81181&node=1
Response
[
  {
    "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"
  }
]
In response to the API request, the following is returned:
  • ownerid — ID of the owner
  • vehiclenumber — license plate number or vehicle name
  • typeid — vehicle type
  • summer_fuel / winter_fuel / idle_fuel — fuel consumption norms (summer, winter, idle)
  • time_zone — time zone where the vehicle is used
  • speed_limit — speed limit
  • account_id — account ID to which the vehicle is linked
  • model / year / vin — model, year of manufacture, and VIN of the vehicle
  • fuel_type — type of fuel
  • driver_name / driver_phone — name and phone number of the assigned driver
  • config — JSON with additional configuration (fuel settings, engine hours, restrictions, etc.)