Работа с GPS-Мониторингом

Открытое API GPS-устройств позволяет зарегистрировать GPS-оборудование в нашей системе, сохранять и просматривать данные о местоположении на карте АТИ Водителя.

Работа с GPS-устройствами

Для начала работы c API нужно зарегистрировать GPS-устройство в системе ATI.SU.

Зарегистрировать новое устройство или обновить существующее
Удалить устройство
Получить устройство по device_id
Получить все мои устройства

Отправка координат

Когда заказ находится в исполнении, появляется возможность сохранять координаты с GPS-устройства в системе ATI.SU.

Сохранить GPS-координаты

Получение истории заказа

По мере выполнения заказа можно следить за передвижением водителя через карту, прикрепленную к заказу на сайте ATI.SU. Но также можно запросить эти данные методами, описанными в разделе АТИ Водитель. Данные методы возвращают информацию по всем GPS-устройствам, участвующим в сделке, включая приложение «АТИ Водитель».

Получение информации о пройденном маршруте АТИ Водителя
Получение истории

Методы для работы с Заказами с участием АТИ Водителя

Регистрация и обновление GPS-устройства

Регистрирует новое устройство в системе. Информация об этом устройстве будет отображаться на карте заказа, по которому устройство вело записи.

Добавить или обновить gps устройство

post /v1/driver/public/gps/device

Модель и примеры
Консоль

Запрос

Модель

{...}

name: string (nullable)

Название для GPS устройства

description: string (nullable)

Описание вашего устройства

device_id: string (nullable)

Идентификатор устройства. Если не задан, генерируется самостоятельно

}

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/gps/device' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"Моё gps устройство","description":"Лежит в машине Х000ХY178","device_id":"2fb965f2-85e9-4213-90e7-f396e47219e7"}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1/driver/public/gps/device", "{""name"":""Моё gps устройство"",""description"":""Лежит в машине Х000ХY178"",""device_id"":""2fb965f2-85e9-4213-90e7-f396e47219e7""}");

Ответ

200 Ок

Модель

null

Пример

null

201 Создан новый объект

Модель

null

Пример

null

4XX Ошибка запроса

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки для разработчиков

}

Пример

{...}

"error_code":"validation_error",

"reason":"Ошибка валидации полей phone и device_id"

}

Удаление GPS-устройства

Удаляет ранее зарегистрированное устройство. Это устройство больше не будет возвращаться в список ваших устройств. Все существующие записи, сделанные удаленным устройством, сохранятся.

Удалить gps устройство

delete /v1/driver/public/gps/device

Модель и примеры
Консоль

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/gps/device' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1/driver/public/gps/device");

Ответ

200 Ок

Модель

null

Пример

null

4XX Ошибка запроса

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки для разработчиков

}

Пример

{...}

"error_code":"validation_error",

"reason":"Ошибка валидации полей phone и device_id"

}

Получение устройства по device_id

Получить устройство по device_id

Получить gps устройство по device_id

get /v1/driver/public/gps/device_info

Модель и примеры
Консоль

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/gps/device_info' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1/driver/public/gps/device_info");

Ответ

200 Ок

Модель

null

Пример

null

401 Ошибка авторизации

Модель

null

Пример

null

404 Девайс не найден

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки для разработчиков

}

Пример

{...}

"error_code":"validation_error",

"reason":"Ошибка валидации полей phone и device_id"

}

4XX Ошибка запроса

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки для разработчиков

}

Пример

{...}

"error_code":"validation_error",

"reason":"Ошибка валидации полей phone и device_id"

}

Получение всех моих устройств

Получить все мои устройства. Метод для получения всех устройств, принадлежащих вашему аккаунту.

Получить все gps устройства контакта

get /v1/driver/public/gps/all_devices

Модель и примеры
Консоль

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/gps/all_devices' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1/driver/public/gps/all_devices");

Ответ

200 Ок

Модель

null

Пример

null

4XX Ошибка запроса

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки для разработчиков

}

Пример

{...}

"error_code":"validation_error",

"reason":"Ошибка валидации полей phone и device_id"

}

Сохранение GPS-координат устройства

Сохраняет GPS-координаты устройства. Во входящих параметрах необходимо указать, по какому Заказу ведутся записи. При этом указанная сделка должна находиться в статусе «В исполнении».

Записать координаты

post /v1/driver/public/gps/coordinates

Модель и примеры
Консоль

Запрос

Модель

{...}

deal_id: uuid

device_id: string (nullable)

coordinates:[{...}]

lon: double

lat: double

location_date: date-time

}]

}

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/gps/coordinates' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","device_id":"string","coordinates":[{"lon":0.5,"lat":0.5,"location_date":"1970-01-01T00:00:00.000Z"}]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1/driver/public/gps/coordinates", "{""deal_id"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""device_id"":""string"",""coordinates"":[{""lon"":0.5,""lat"":0.5,""location_date"":""1970-01-01T00:00:00.000Z""}]}");

Ответ

200 Ок

Модель

null

Пример

null

4XX Ошибка запроса

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки для разработчиков

}

Пример

{...}

"error_code":"validation_error",

"reason":"Ошибка валидации полей phone и device_id"

}

Получение информации о пройденном маршруте и истории событий

Получение информации о пройденном маршруте

Возвращает информацию о маршруте, пройденном водителем с использованием приложения, датчиков Wialon или GPS-устройств, добавленных с помощью API, а также о начальной, конечной и промежуточных точках маршрута. Ответ метода можно использовать, например, для отображения маршрута на карте.

Получение информации о пройденном маршруте АТИ Водителя

get /v1.2/orders/carrier/map_route/by_deal

Модель и примеры
Консоль

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/carrier/map_route/by_deal' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.2/orders/carrier/map_route/by_deal");

Ответ

200 Информация для карты

Модель

[{...}]

goals:[{...}]

Точки загрузки/разгрузки

longitude: double

Долгота

latitude: double

Широта

events:[{...}]

События

type: enum

[0, 1, 2]

Тип события

0 — Значение по умолчанию
1 — Метаинформация об устройстве. Включает в себя события выключения GPS, подмены GPS координат, выключения телефона.
2 — Информация о статусе заказа (статусы выбираются водителем в приложении)

tag: string

Тэг произошедшего события

date: date-time

Дата начала

date_to: date-time (nullable)

Дата окончания

time: string

Время начала

time_to: string

Время окончания

location_name:{...}

Информация о местоположении

country: string

Страна

region: string

Регион

city: string

Город

address: string

Адрес

}

}]

ordinal_id: int32

Номер по порядку

trace: boolean

Нужно ли прокладывать маршрут для этой точки

}]

traces:[{...}]

Точки траектории движения водителя

car:{...}

Транспортное средство

driver_phone: string

Номер телефона водителя

car_status: enum

[0, 1, 2, 3, 4, 5]

Тип события

0 — Без происшествий
1 — GPS был выключен
2 — Попытка подделки GPS
3 — Не было данных
4 — Режим энергосбережения
5 — Стоянка

}

first_action: date-time

Время начала действия

last_action: date-time

Время окончания действия

points:[{...}]

Точки маршрута

longitude: double

Долгота

latitude: double

Широта

events:[{...}]

События

type: enum

[0, 1, 2]

Тип события

0 — Значение по умолчанию
1 — Метаинформация об устройстве. Включает в себя события выключения GPS, подмены GPS координат, выключения телефона.
2 — Информация о статусе заказа (статусы выбираются водителем в приложении)

tag: string

Тэг произошедшего события

date: date-time

Дата начала

date_to: date-time (nullable)

Дата окончания

time: string

Время начала

time_to: string

Время окончания

location_name:{...}

Информация о местоположении

country: string

Страна

region: string

Регион

city: string

Город

address: string

Адрес

}

}]

location_date: date-time

Время местоположения

is_fake: boolean

Флаг поддельного сигнала GPS

is_disabled: boolean

Фдаг выключенности GPS

is_no_data: boolean

Флаг наличия данных

is_power_saving: boolean

Флаг включенности режима энергосбережения

is_empty_run: boolean

Флаг холостого хода

is_parking: boolean

Стоянка

}]

Пример

[...]

{...}

"goals":[...],

{...}

"longitude":0.5,

"latitude":0.5,

"events":[...],

{...}

"type":0,

"tag":"string",

"date":"1970-01-01T00:00:00.000Z",

"date_to":"1970-01-01T00:00:00.000Z",

"time":"string",

"time_to":"string",

"location_name":{...}

"country":"string",

"region":"string",

"city":"string",

"address":"string"

}

"ordinal_id":0,

"trace":false

}

"traces":[...]

{...}

"car":{...},

"driver_phone":"string",

"car_status":0

"first_action":"1970-01-01T00:00:00.000Z",

"last_action":"1970-01-01T00:00:00.000Z",

"points":[...]

{...}

"longitude":0.5,

"latitude":0.5,

"events":[...],

{...}

"type":0,

"tag":"string",

"date":"1970-01-01T00:00:00.000Z",

"date_to":"1970-01-01T00:00:00.000Z",

"time":"string",

"time_to":"string",

"location_name":{...}

"country":"string",

"region":"string",

"city":"string",

"address":"string"

}

"location_date":"1970-01-01T00:00:00.000Z",

"is_fake":false,

"is_disabled":false,

"is_no_data":false,

"is_power_saving":false,

"is_empty_run":false,

"is_parking":false

}

]

}

]

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Получение истории

Список событий, произошедших в пути следования водителя. Например: поломка, ДТП, отсутствие данных и прочее.

Получение истории

get /v1.2/orders/carrier/map/history

Модель и примеры
Консоль

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/carrier/map/history' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.2/orders/carrier/map/history");

Ответ

200 История выполнения заказа водителем

Модель

[{...}]

events:[{...}]

События в пути

date: date-time

Время события

event:{...}

Событие

type: enum

[0, 1, 2]

Тип события

0 — Значение по умолчанию
1 — Метаинформация об устройстве. Включает в себя события выключения GPS, подмены GPS координат, выключения телефона.
2 — Информация о статусе заказа (статусы выбираются водителем в приложении)

tag: string

Тэг произошедшего события

date: date-time

Дата начала

date_to: date-time (nullable)

Дата окончания

time: string

Время начала

time_to: string

Время окончания

location_name:{...}

Информация о местоположении

country: string

Страна

region: string

Регион

city: string

Город

address: string

Адрес

}

longitude: double

Долгота

latitude: double

Широта

params: [string]

}]

Пример

[...]

{...}

"events":[...]

{...}

"date":"1970-01-01T00:00:00.000Z",

"event":{...},

"type":0,

"tag":"string",

"date":"1970-01-01T00:00:00.000Z",

"date_to":"1970-01-01T00:00:00.000Z",

"time":"string",

"time_to":"string",

"location_name":{...}

"country":"string",

"region":"string",

"city":"string",

"address":"string"

}

"longitude":0.5,

"latitude":0.5,

"params":[...]

"string"

]

}

]

}

]

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}