Заряд батареи по VIN

Этот API получает информацию о состоянии заряда батареи транспортного средства по VIN.
Работает только для объектов, у которых:
  •  заполнено поле VIN в карточке объекта
  • подключен датчик заряда батареи
В запросе можно указать несколько VIN, тогда в ответе вернётся информация по всем указанным объектам.

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

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

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

Метод запроса

 POST
Работа с этим API состоит из двух шагов:
1. Авторизация — получение токена для доступа к данным
2. Запрос данных — использование токена для получения информации о батарее по VIN
 

1. Авторизация

Перед тем как запрашивать данные, необходимо авторизоваться.
Тело запроса:
{
  "login": "ваш_логин",
  "password": "ваш_пароль",
  "cmd": "auth"
}
Ответ
{
  "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
 
В ответе вы получите токен — длинную уникальную строку.
Этот токен нужен для идентификации пользователя при последующих запросах. Без токена API не отдаст данные о батарее.

2. Получение данных датчика батареи

После получения токена можно запросить информацию о батарее.
Параметры запроса
  • Number — список VIN транспортных средств, информацию о которых вы хотите получить.
  • DateFrom — дата и время начала периода (в формате ISO 8601).
  • DateTo — дата и время конца периода.
  • cmd=vehicle — команда API для запроса данных о транспортном средстве
Заголовки запроса:
  • Authorization: Bearer <token> — указываем токен, полученный при авторизации
  • Content-Type: application/json — указываем, что тело запроса в формате JSON
Тело запроса:
{
  "Number": ["VIN_объекта"],
  "DateFrom": "2023-12-03T00:00:00",
  "DateTo": "2023-12-12T00:00:00",
  "cmd": "vehicle"
}
Ответ
[
  {
    "Number": "456789123",
    "ApplicationNumber": null,
    "CurrentStatus": "ACTIVE",
    "CloseDateTime": "",
    "LastSyncDate": "2024-08-28 15:42:45",
    "AlarmDateTime": "2024-08-28 15:42:45",
    "Latitude": "55.578352",
    "Longitude": "38.125267",
    "BatteryCharge": "полный заряд",
    "LocationLinesID": "",
    "FullAddress": "улица Гарнаева, Рынок, Жуковский, Московская область, Россия",
    "Country": "Россия",
    "Region": "Московская область",
    "Town": "Жуковский",
    "Street": "улица Гарнаева",
    "House": null,
    "numberRegion": 10
  }
]
 
В ответ на API-запрос возвращается:
  • Number — VIN транспортного средства
  • CurrentStatus — текущий статус объекта
  • LastSyncDate — дата последней синхронизации
  • BatteryCharge — уровень заряда батареи
  • FullAddress, Country, Region, Town, Street — местоположение объекта
  • Latitude, Longitude — координаты объекта