АТИ Водитель

Работа с приложением «АТИ Водитель»

АТИ Водитель — сервис для мониторинга заказов в режиме реального времени. Сервис позволяет отправлять заказы водителю, получать актуальные статусы перевозки и отслеживать местоположение груза на карте.

До начала выполнения заказа

Для начала работы с приложением «АТИ Водитель» необходимо, чтобы в справочнике транспортных средств был водитель, с установленным приложением «АТИ Водитель». Проверить наличие у водителя приложения можно двумя способами:

По driverId
По номерам телефонов

Если у водителя не установлено приложение, его можно пригласить.

Приглашение водителя установить приложение

Перевозчик приглашает водителя установить приложение в разделе Справочники. Водитель устанавливает приложение и регистрируется в нем. Водитель также может зарегистрироваться самостоятельно.

Приглашение водителя в приложение

Взятие груза

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

Установка доступа грузовладельца к данным из АТИ Водителя

Выполнение заказа

Назначение заказа на водителя

После того как заказ перейдет в исполнение, необходимо отправить водителю данные о заказе — адреса точек загрузки и разгрузки, дату и время, информацию о контактных лицах на месте. После этого водитель в приложении сможет изменять статусы заказа, а приложение будет отправлять данные о его местоположении.

Назначить заказ водителю
Получение информации по заказу для водителя
Обновить данные по заказу
Снять водителя с заказа

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

По мере выполнения заказа можно следить за передвижением водителя по карте и отслеживать историю выполнения заказа.

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

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

Проверка наличия приложения у водителя по номерам телефонов

Возвращает информацию о наличии приложения «АТИ Водитель» и последней активности пользователей. Также здесь можно узнать об смс приглашении водителя в приложение, когда был приглашён, каким контактом вашей фирмы и дошло ли оповещение до адресата.

Получение данных о водителе из приложения АТИ Водитель по номеру телефона

post /v1/driver/public/presence

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

Запрос

Модель

{...}

phones*: [string]

Номера телефонов водителей. Можно получить из справочника водителей

}

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/presence' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"phones":["79338508858","79031234567"]}'

Процедура Выполнить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/presence", "{""phones"":[""79338508858"",""79031234567""]}");

Ответ

200 Данные о водителях

Модель

[{...}]

phone: string (nullable)

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

initial_phone: string (nullable)

Номер телефона из запроса (до нормализации)

last_active: date-time (nullable)

Дата и время последней активности водителя в приложении АТИ Водитель (UTC)

has_tracker: boolean

Установлено ли приложение АТИ Водитель на телефон водителя

sms_invite_status:{...}

invite_sent: boolean

Было ли отправлено SMS-приглашение водителю

contact_name: string (nullable)

Имя контакта фирмы, от имени которого отправлено приглашение

ati_id: int32 (nullable)

Код фирмы в АТИ, отправившей приглашение

contact_id: int32 (nullable)

Идентификатор контакта фирмы, отправившей приглашение

sms_status: enum

[empty, created, error, sent]

when: date-time (nullable)

Дата и время создания SMS-приглашения (UTC)

}

}]

Пример

[...]

{...},

"phone":"79338508858",

"initial_phone":"79338508858",

"last_active":"2024-06-15T10:30:00Z",

"has_tracker":true,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":null,

"ati_id":null,

"contact_id":null,

"sms_status":"Empty",

"when":null

}

{...}

"phone":"79031234567",

"initial_phone":"89031234567",

"last_active":null,

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":true,

"contact_name":"Иванов Иван",

"ati_id":14612,

"contact_id":0,

"sms_status":"Sent",

"when":"2024-06-10T14:00:00Z"

}

]

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

Отправление смс-приглашения с просьбой установить приложение

Отправляет по указанному номеру смс со ссылкой на приложение «АТИ Водитель». Метод имеет ограничения: один контакт может приглашать водителя по одному номеру только раз в 10 минут и 3 раза в сутки, лимит на количество смс для фирмы — 30 смс в сутки. Лимиты сбрасываются по ночам.

Отправка SMS-приглашения водителю для установки приложения АТИ Водитель

post /v1/driver/public/invite

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

Запрос

Модель

{...}

Phone*: string

Минимальное количество символов: 1

Номер телефона водителя. Можно получить из справочника водителей

}

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/invite' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"Phone":"+7(933)8508858"}'

Процедура Выполнить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/invite", "{""Phone"":""+7(933)8508858""}");

Ответ

200 Результат отправки приглашения

Модель

{...}

ok: boolean

Успешно ли отправлено SMS-приглашение

details: string (nullable)

Дополнительная информация: число отправленных приглашений за сегодня или описание ошибки

}

Пример

{...}

"ok":true,

"details":"Сегодня вами было отправлено приглашений: 1"

}

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

429 Превышен лимит запросов. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"sms_invites_limit_reached",

"reason":"Превышен лимит отправки смс-приглашений."

}

Получение информации по заказу для водителя

Возвращает массив точек маршрута, по которым водитель будет следовать, используя приложение «АТИ Водитель». Каждая точка соответствует загрузке или разгрузке, и также содержит информацию об адресе, географических координатах, дате и времени, контактном лице на точке.

Получить данные о перевозке водителя для ГП

get /gw/driver/v1/carrier/deals/{dealId}/transportations

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

Запрос

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

CURL
1C

curl 'https://api.ati.su/gw/driver/v1/carrier/deals/{dealId}/transportations' \
  -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", "/gw/driver/v1/carrier/deals/{dealId}/transportations");

Ответ

200 Маршрут перевозки

Модель

[{...}]

deal_point_id: uuid

Идентификатор точки заказа

ordinal_id: int32 (nullable)

Порядковый номер точки в маршруте

time: string (nullable)

Время начала (формат hh:mm)

date: string (nullable)

Дата начала (формат dd.MM.yyyy)

time_to: string (nullable)

Время окончания (формат hh:mm)

date_to: string (nullable)

Дата окончания (формат dd.MM.yyyy)

lat: double (nullable)

Широта

lon: double (nullable)

Долгота

address: string (nullable)

Адрес точки

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

point_type: int32 (nullable)

Тип точки: 1 — погрузка, 2 — разгрузка

contact_persons:[{...}]

Контактные лица на точке

Имя контактного лица

phone: string (nullable)

Телефон контактного лица

ordinal_id: int32

Порядковый номер контакта на точке

}]

note: string (nullable)

Примечание к точке

timeslots_warehouse_id: int32 (nullable)

Id склада. Значение из API временных окон

organization_id: uuid (nullable)

Id организации. Получить из справочника организаций

}]

Пример

[...]

{...}

"deal_point_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890",

"ordinal_id":1,

"time":"09:00",

"date":"20.06.2024",

"time_to":"12:00",

"date_to":"20.06.2024",

"lat":55.7558,

"lon":37.6173,

"address":"г. Москва, ул. Примерная, д. 1",

"city_id":3611,

"region_id":151,

"country_id":1,

"point_type":1,

"contact_persons":[...],

{...}

"name":"Иванов Иван",

"phone":"+7(495)123-45-67",

"ordinal_id":1

}

"note":"Погрузка",

"timeslots_warehouse_id":12345,

"organization_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901"

}

]

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

403 Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_access_denied_error",

"reason":"Отказано в доступе: Действие доступно только перевозчику"

}

404 Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_not_found_error",

"reason":"Заказ не найден"

}

Назначение заказа на водителя

Привязывает водителя к заказу, создает информацию, необходимую водителю для использования приложения «АТИ Водитель» и отправляет ее на приложение. В тело метода включается информация о типе точки (загрузка или разгрузка), а также информация об адресе, географических координатах, дате и времени, контактном лице на точке.

Отправить маршрут перевозки водителю для ГП

post /gw/driver/v1/carrier/deals/{dealId}/transportations

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

Запрос

Модель

[{...}]

deal_point_id*: uuid

Идентификатор точки заказа. Получить из API заказов

ordinal_id: int32 (nullable)

Порядковый номер точки в маршруте

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

point_type: enum

[loading, unloading]

organization_id: uuid (nullable)

Id организации. Получить из справочника организаций

time: string (nullable)

Время начала (формат hh:mm)

date: string (nullable)

Дата начала (формат dd.MM.yyyy)

time_to: string (nullable)

Время окончания (формат hh:mm)

date_to: string (nullable)

Дата окончания (формат dd.MM.yyyy)

lat: double (nullable)

Широта

lon: double (nullable)

Долгота

address: string (nullable)

Адрес точки

contact_persons:[{...}]

Контактные лица на точке

Имя контактного лица

phone: string (nullable)

Телефон контактного лица

ordinal_id: int32

Порядковый номер контакта на точке

}]

note: string (nullable)

Примечание к точке

timeslots_warehouse_id: int32 (nullable)

Id склада. Значение из API временных окон

}]

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

CURL
1C

curl 'https://api.ati.su/gw/driver/v1/carrier/deals/{dealId}/transportations' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[{"deal_point_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","ordinal_id":1,"city_id":3611,"region_id":151,"country_id":1,"point_type":"loading","organization_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","time":"09:00","date":"20.06.2024","time_to":"12:00","date_to":"20.06.2024","lat":55.7558,"lon":37.6173,"address":"г. Москва, ул. Примерная, д. 1","contact_persons":[{"name":"Иванов Иван","phone":"+7(495)123-45-67","ordinal_id":1}],"note":"Погрузка","timeslots_warehouse_id":12345}]'

Процедура Выполнить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", "/gw/driver/v1/carrier/deals/{dealId}/transportations", "[{""deal_point_id"":""a1b2c3d4-e5f6-7890-abcd-ef1234567890"",""ordinal_id"":1,""city_id"":3611,""region_id"":151,""country_id"":1,""point_type"":""loading"",""organization_id"":""b2c3d4e5-f6a7-8901-bcde-f12345678901"",""time"":""09:00"",""date"":""20.06.2024"",""time_to"":""12:00"",""date_to"":""20.06.2024"",""lat"":55.7558,""lon"":37.6173,""address"":""г. Москва, ул. Примерная, д. 1"",""contact_persons"":[{""name"":""Иванов Иван"",""phone"":""+7(495)123-45-67"",""ordinal_id"":1}],""note"":""Погрузка"",""timeslots_warehouse_id"":12345}]");

Ответ

200 Маршрут перевозки

Модель

[{...}]

deal_point_id: uuid

Идентификатор точки заказа

ordinal_id: int32 (nullable)

Порядковый номер точки в маршруте

time: string (nullable)

Время начала (формат hh:mm)

date: string (nullable)

Дата начала (формат dd.MM.yyyy)

time_to: string (nullable)

Время окончания (формат hh:mm)

date_to: string (nullable)

Дата окончания (формат dd.MM.yyyy)

lat: double (nullable)

Широта

lon: double (nullable)

Долгота

address: string (nullable)

Адрес точки

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

point_type: int32 (nullable)

Тип точки: 1 — погрузка, 2 — разгрузка

contact_persons:[{...}]

Контактные лица на точке

Имя контактного лица

phone: string (nullable)

Телефон контактного лица

ordinal_id: int32

Порядковый номер контакта на точке

}]

note: string (nullable)

Примечание к точке

timeslots_warehouse_id: int32 (nullable)

Id склада. Значение из API временных окон

organization_id: uuid (nullable)

Id организации. Получить из справочника организаций

}]

Пример

[...]

{...}

"deal_point_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890",

"ordinal_id":1,

"time":"09:00",

"date":"20.06.2024",

"time_to":"12:00",

"date_to":"20.06.2024",

"lat":55.7558,

"lon":37.6173,

"address":"г. Москва, ул. Примерная, д. 1",

"city_id":3611,

"region_id":151,

"country_id":1,

"point_type":1,

"contact_persons":[...],

{...}

"name":"Иванов Иван",

"phone":"+7(495)123-45-67",

"ordinal_id":1

}

"note":"Погрузка",

"timeslots_warehouse_id":12345,

"organization_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901"

}

]

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

403 Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_access_denied_error",

"reason":"Отказано в доступе: Действие доступно только перевозчику"

}

404 Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_not_found_error",

"reason":"Заказ не найден"

}

Обновление заказа для АТИ Водителя

Обновляет информацию, необходимую водителю для использования приложения «АТИ Водитель» и отправляет ее на приложение. В тело метода включается информация о типе точки (загрузка или разгрузка), а также информация об адресе, географических координатах, дате и времени, контактном лице на точке.

Изменить маршрут перевозки водителю для ГП

put /gw/driver/v1/carrier/deals/{dealId}/transportations

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

Запрос

Модель

[{...}]

deal_point_id*: uuid

Идентификатор точки заказа. Получить из API заказов

ordinal_id: int32 (nullable)

Порядковый номер точки в маршруте

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

point_type: enum

[loading, unloading]

organization_id: uuid (nullable)

Id организации. Получить из справочника организаций

time: string (nullable)

Время начала (формат hh:mm)

date: string (nullable)

Дата начала (формат dd.MM.yyyy)

time_to: string (nullable)

Время окончания (формат hh:mm)

date_to: string (nullable)

Дата окончания (формат dd.MM.yyyy)

lat: double (nullable)

Широта

lon: double (nullable)

Долгота

address: string (nullable)

Адрес точки

contact_persons:[{...}]

Контактные лица на точке

Имя контактного лица

phone: string (nullable)

Телефон контактного лица

ordinal_id: int32

Порядковый номер контакта на точке

}]

note: string (nullable)

Примечание к точке

timeslots_warehouse_id: int32 (nullable)

Id склада. Значение из API временных окон

}]

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

CURL
1C

curl 'https://api.ati.su/gw/driver/v1/carrier/deals/{dealId}/transportations' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[{"deal_point_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","ordinal_id":1,"city_id":3611,"region_id":151,"country_id":1,"point_type":"loading","organization_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","time":"09:00","date":"20.06.2024","time_to":"12:00","date_to":"20.06.2024","lat":55.7558,"lon":37.6173,"address":"г. Москва, ул. Примерная, д. 1","contact_persons":[{"name":"Иванов Иван","phone":"+7(495)123-45-67","ordinal_id":1}],"note":"Погрузка","timeslots_warehouse_id":12345}]'

Процедура Выполнить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Запрос("PUT", "https://api.ati.su", "/gw/driver/v1/carrier/deals/{dealId}/transportations", "[{""deal_point_id"":""a1b2c3d4-e5f6-7890-abcd-ef1234567890"",""ordinal_id"":1,""city_id"":3611,""region_id"":151,""country_id"":1,""point_type"":""loading"",""organization_id"":""b2c3d4e5-f6a7-8901-bcde-f12345678901"",""time"":""09:00"",""date"":""20.06.2024"",""time_to"":""12:00"",""date_to"":""20.06.2024"",""lat"":55.7558,""lon"":37.6173,""address"":""г. Москва, ул. Примерная, д. 1"",""contact_persons"":[{""name"":""Иванов Иван"",""phone"":""+7(495)123-45-67"",""ordinal_id"":1}],""note"":""Погрузка"",""timeslots_warehouse_id"":12345}]");

Ответ

200 Маршрут перевозки

Модель

[{...}]

deal_point_id: uuid

Идентификатор точки заказа

ordinal_id: int32 (nullable)

Порядковый номер точки в маршруте

time: string (nullable)

Время начала (формат hh:mm)

date: string (nullable)

Дата начала (формат dd.MM.yyyy)

time_to: string (nullable)

Время окончания (формат hh:mm)

date_to: string (nullable)

Дата окончания (формат dd.MM.yyyy)

lat: double (nullable)

Широта

lon: double (nullable)

Долгота

address: string (nullable)

Адрес точки

city_id: int32 (nullable)

Id города. Значение из словаря городов АТИ

region_id: int32 (nullable)

Id региона. Значение из словаря регионов АТИ

country_id: int32 (nullable)

Id страны. Значение из словаря стран АТИ

point_type: int32 (nullable)

Тип точки: 1 — погрузка, 2 — разгрузка

contact_persons:[{...}]

Контактные лица на точке

Имя контактного лица

phone: string (nullable)

Телефон контактного лица

ordinal_id: int32

Порядковый номер контакта на точке

}]

note: string (nullable)

Примечание к точке

timeslots_warehouse_id: int32 (nullable)

Id склада. Значение из API временных окон

organization_id: uuid (nullable)

Id организации. Получить из справочника организаций

}]

Пример

[...]

{...}

"deal_point_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890",

"ordinal_id":1,

"time":"09:00",

"date":"20.06.2024",

"time_to":"12:00",

"date_to":"20.06.2024",

"lat":55.7558,

"lon":37.6173,

"address":"г. Москва, ул. Примерная, д. 1",

"city_id":3611,

"region_id":151,

"country_id":1,

"point_type":1,

"contact_persons":[...],

{...}

"name":"Иванов Иван",

"phone":"+7(495)123-45-67",

"ordinal_id":1

}

"note":"Погрузка",

"timeslots_warehouse_id":12345,

"organization_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901"

}

]

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

403 Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_access_denied_error",

"reason":"Отказано в доступе: Действие доступно только перевозчику"

}

404 Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_not_found_error",

"reason":"Заказ не найден"

}

Снятие водителя с заказа

Отвязывает водителя от заказа и удаляет информацию, созданную при назначении заказа на водителя.

Отозвать маршрут перевозки у водителя для ГП

delete /gw/driver/v1/carrier/deals/{dealId}/transportations

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

Запрос

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

CURL
1C

curl 'https://api.ati.su/gw/driver/v1/carrier/deals/{dealId}/transportations' \
  -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", "/gw/driver/v1/carrier/deals/{dealId}/transportations");

Ответ

200 Перевозка отозвана у водителя

Успешный ответ

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

403 Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_access_denied_error",

"reason":"Отказано в доступе: Действие доступно только перевозчику"

}

404 Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_not_found_error",

"reason":"Заказ не найден"

}

Методы для работы с GPS-мониторингом в Заказах

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

Возвращает информацию о маршруте, пройденном водителем с использованием приложения, датчиков 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:

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

ONE-OF

enum

[0, 1, 2]

tag: string

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

date: date-time

Дата начала

date_to: date-time (nullable)

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

time: string

Время начала

time_to: string

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

location_name:

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

ONE-OF

1:{...}

country: string

Страна

region: string

Регион

city: string

Город

address: string

Адрес

}

}]

ordinal_id: int32

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

trace: boolean

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

}]

traces:[{...}]

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

car:

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

ONE-OF

1:{...}

driver_phone: string

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

car_status:

Тип события

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

ONE-OF

enum

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

}

first_action: date-time

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

last_action: date-time

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

points:[{...}]

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

longitude: double

Долгота

latitude: double

Широта

events:[{...}]

События

type:

ONE-OF

enum

[0, 1, 2]

tag: string

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

date: date-time

Дата начала

date_to: date-time (nullable)

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

time: string

Время начала

time_to: string

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

location_name:

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

ONE-OF

1:{...}

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/)

Модель

ONE-OF

(nullable)

1:{...}

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

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:

Событие

ONE-OF

1:{...}

type:

ONE-OF

enum

[0, 1, 2]

tag: string

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

date: date-time

Дата начала

date_to: date-time (nullable)

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

time: string

Время начала

time_to: string

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

location_name:

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

ONE-OF

1:{...}

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/)

Модель

ONE-OF

(nullable)

1:{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Установка доступа грузовладельца к данным из АТИ Водителя

По умолчанию грузовладелец не может следить за водителем на карте. С помощью метода можно открывать и закрывать грузовладельцу доступ к этой информации (данные, возвращаемые методом /map_route/by_deal).

Установка доступа грузовладельца к данным из АТИ Водителя.

post /v1.2/orders/carrier/{dealId}/tracker_access

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

Запрос

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

CURL
1C

curl 'https://api.ati.su/v1.2/orders/carrier/{dealId}/tracker_access' \
  -X 'POST' \
  -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Запрос("POST", "https://api.ati.su", "/v1.2/orders/carrier/{dealId}/tracker_access");

Ответ

200 Успешное выполнение операции

Успешный ответ

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

Модель

ONE-OF

(nullable)

1:{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Метод получения последней существующей локации водителя

Если у водителя установлено приложение АТИ.Водитель можно запросить его последнее местоположение.

Получение сводной информации об активности водителей по заказам

post /v1/driver/public/deal/users_activity

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

Запрос

Модель

{...}

deals*:[{...}]

Список пар «телефон водителя — заказ» для запроса активности

phone*: string

Минимальное количество символов: 1

Номер телефона водителя. Можно получить из справочника водителей

deal_id*: uuid

GUID заказа. Получить из API заказов

}]

}

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

CURL
1C

curl 'https://api.ati.su/v1/driver/public/deal/users_activity' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"deals":[{"phone":"+7(933)8508858","deal_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}]}'

Процедура Выполнить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/deal/users_activity", "{""deals"":[{""phone"":""+7(933)8508858"",""deal_id"":""a1b2c3d4-e5f6-7890-abcd-ef1234567890""}]}");

Ответ

200 Активность водителей по заказам

Модель

{...}

deals:[{...}]

Сводная информация по каждому запрошенному заказу

deal_id: string (nullable)

GUID заказа

initial_phone: string (nullable)

Номер телефона из запроса (до нормализации)

phone: string (nullable)

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

tracker_offer_status: enum

[none, sent, accepted_by_driver, rejected_by_driver]

reason_changing_offer_status: string (nullable)

Причина изменения статуса предложения

status: enum

[none, go_to_loading, ready_to_load, loading, loaded, ready_to_unload, unloading, unloaded, breakdown, accident, arrest, container_received_to_loading, container_on_loading, container_finished_loading, container_sent_from_loading, container_received_to_unloading, container_on_unloading, container_finished_unloading, container_sent_from_unloading, empty_container_received, empty_container_sent, completed_by_driver]

extended_status: enum

[none, completed_by_driver]

tracker_finished_at: date-time (nullable)

Дата и время завершения отслеживания (UTC)

last_active: date-time (nullable)

Дата и время последней активности водителя в приложении (UTC)

has_tracker: boolean

Установлено ли приложение АТИ Водитель на телефон водителя

last_location:{...}

lon: double

Долгота

lat: double

Широта

events:[{...}]

События в точке (статусы перевозки, мета-события GPS)

type: enum

[not_set, meta, status, photo, other]

tag: string (nullable)

Тег события (код статуса или мета-события)

date: date-time (nullable)

Дата события (UTC)

date_to: date-time (nullable)

Дата окончания события (UTC)

time: string (nullable)

Время события (формат hh:mm)

time_to: string (nullable)

Время окончания события (формат hh:mm)

location_name:{...}

country: string (nullable)

region: string (nullable)

city: string (nullable)

address: string (nullable)

}

company_info:{...}

ati_id: string (nullable)

}

manager: string (nullable)

Менеджер, связанный с событием

}]

is_fake: boolean

Признак подмены GPS-координат

is_disabled: boolean

GPS отключён на устройстве водителя

is_no_data: boolean

Нет данных о местоположении

is_power_saving: boolean

Устройство в режиме энергосбережения

}

gps_status_date: date-time (nullable)

Дата и время последнего GPS-статуса (UTC)

}]

}

Пример

{...}

"deals":[...]

{...}

"deal_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890",

"initial_phone":"+7(933)8508858",

"phone":"79338508858",

"tracker_offer_status":"sent",

"reason_changing_offer_status":null,

"status":"go_to_loading",

"extended_status":"none",

"tracker_finished_at":null,

"last_active":"2024-06-15T10:30:00Z",

"has_tracker":true,

"last_location":{...},

"lon":37.6173,

"lat":55.7558,

"events":[...]

{...}

"type":"status",

"tag":"go_to_loading",

"date":"2024-06-15T10:25:00Z"

}

]

"gps_status_date":"2024-06-15T10:25:00Z"

}

]

}

400 Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"required_parameter_not_set",

"reason":"Не задано обязательное поле phones"

}

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

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"unauthorized_user",

"reason":"Не удалось авторизовать пользователя."

}

403 Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_access_denied_error",

"reason":"Отказано в доступе: Действие доступно только перевозчику"

}

404 Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

{...}

Тело ответа при ошибке API. Подробнее про ошибки API

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"deal_not_found_error",

"reason":"Заказ не найден"

}