АТИ Водитель

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

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

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

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

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

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

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

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

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

Взятие груза

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

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

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

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

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

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

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

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

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

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

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

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

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

post /v1/driver/public/presence

Модель и примеры

Запрос

Модель

{...}

phones: [string]

Номера телефонов

}

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

CURL

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

1C

Процедура Выполнить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"":[""string""]}");

Ответ

200 Success

Модель

[{...}]

phone: string (nullable)

initial_phone: string (nullable)

last_active: date-time (nullable)

has_tracker: boolean

sms_invite_status:{...}

invite_sent: boolean

contact_name: string (nullable)

ati_id: int32 (nullable)

contact_id: int32 (nullable)

sms_status: enum

[empty, created, error, sent, delivered]

when: date-time (nullable)

}

}]

Пример

[...]

{...}

"phone":"string",

"initial_phone":"string",

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

"has_tracker":false,

"sms_invite_status":{...}

"invite_sent":false,

"contact_name":"string",

"ati_id":0,

"contact_id":0,

"sms_status":"empty",

"when":"1970-01-01T00:00:00.000Z"

}

}

]

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

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}

Пример

{...}

"error_code":"validation_error",

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

}

Консоль

Отправить

Параметры

Нет параметров

{ "phones": [ "string" ] }

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

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

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

post /v1/driver/public/invite

Модель и примеры

Запрос

Модель

{...}

phone: string (nullable)

Номер телефона

}

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

CURL

curl 'https://api.ati.su/v1/driver/public/invite' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"phone":"string"}'

1C

Процедура Выполнить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"":""string""}");

Ответ

200 Success

Модель

{...}

ok: boolean

details: string (nullable)

}

Пример

{...}

"ok":false,

"details":"string"

}

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

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}

Пример

{...}

"error_code":"validation_error",

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

}

Консоль

Отправить

Параметры

Нет параметров

{ "phone": "string" }

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

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

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

get /v1.2/orders/carrier/{dealId}/driver_tracker_points

Модель и примеры

Запрос

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

CURL

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

1C

Процедура Выполнить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/{dealId}/driver_tracker_points");

Ответ

200 Информация по заказу

Модель

[{...}]

deal_point_id: guid

Id точки из Заказа

ordinal_id: int32

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

time: string

Время

date: string

Дата

time_to: string

Время до (если есть)

date_to: string

Дата до (если есть)

lat: double (nullable)

Широта точки

lon: double (nullable)

Долгота точки

address: string

Адрес

city_id: int32

Id города
Значение из словаря городов ATI.SU

region_id: int32

Id региона
Значение из словаря регионов ATI.SU

country_id: int32

Id страны
Значение из словаря стран ATI.SU

point_type: enum

[1, 2, 3, 8]

Тип точки

• 1 — Загрузка
• 2 — Разгрузка

contact_persons:[{...}]

Список контактов (не более 10 контактов)

name: string

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

phone: string

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

ordinal_id: int32

Порядковый номер добавления контактного лица (от 1 до 10)

}]

note: string

Примечание (до 1000 символов)

timeslots_warehouse_id: int32 (nullable)

Айди склада из временных окон

}]

Пример

[...]

{...}

"deal_point_id":"2fb965f2-85e9-4213-90e7-f396e47219e7",

"ordinal_id":1,

"time":"10:00",

"date":"2.1.2019",

"time_to":"1:00",

"date_to":"13.2.2019",

"lat":30.3330562,

"lon":59.974006,

"address":"гор. Санкт-Петербург",

"city_id":0,

"region_id":0,

"country_id":0,

"point_type":0,

"contact_persons":[...],

{...}

"name":"string",

"phone":"string",

"ordinal_id":1

}

],

"note":"string",

"timeslots_warehouse_id":0

}

]

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

Модель

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Консоль

Отправить

Параметры

dealId guid

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

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

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

put /v1.2/orders/carrier/{dealId}/driver_tracker_points

Модель и примеры

Запрос

Модель

[{...}]

deal_point_id*: guid

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

Id точки из Заказа

time: string

Время

date: string

Дата

time_to: string

Время до (если есть)

date_to: string

Дата до (если есть)

lat: double (nullable)

Широта точки

lon: double (nullable)

Долгота точки

address: string

Адрес

contact_persons:[{...}]

Список контактов (не более 10 контактов)

name: string

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

phone: string

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

ordinal_id: int32

Порядковый номер добавления контактного лица (от 1 до 10)

}]

note: string

Примечание (до 1000 символов)

timeslots_warehouse_id: int32 (nullable)

Айди склада из временных окон

}]

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

CURL

curl 'https://api.ati.su/v1.2/orders/carrier/{dealId}/driver_tracker_points' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[{"deal_point_id":"2fb965f2-85e9-4213-90e7-f396e47219e7","time":"10:00","date":"02.01.2019","time_to":"01:00","date_to":"13.02.2019","lat":30.3330562,"lon":59.974006,"address":"гор. Санкт-Петербург","contact_persons":[{"name":"string","phone":"string","ordinal_id":1}],"note":"string","timeslots_warehouse_id":0}]'

1C

Процедура Выполнить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", "/v1.2/orders/carrier/{dealId}/driver_tracker_points", "[{""deal_point_id"":""2fb965f2-85e9-4213-90e7-f396e47219e7"",""time"":""10:00"",""date"":""02.01.2019"",""time_to"":""01:00"",""date_to"":""13.02.2019"",""lat"":30.3330562,""lon"":59.974006,""address"":""гор. Санкт-Петербург"",""contact_persons"":[{""name"":""string"",""phone"":""string"",""ordinal_id"":1}],""note"":""string"",""timeslots_warehouse_id"":0}]");

Ответ

200 Созданная информация по заказу

Модель

[{...}]

deal_point_id: guid

Id точки из Заказа

ordinal_id: int32

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

time: string

Время

date: string

Дата

time_to: string

Время до (если есть)

date_to: string

Дата до (если есть)

lat: double (nullable)

Широта точки

lon: double (nullable)

Долгота точки

address: string

Адрес

city_id: int32

Id города
Значение из словаря городов ATI.SU

region_id: int32

Id региона
Значение из словаря регионов ATI.SU

country_id: int32

Id страны
Значение из словаря стран ATI.SU

point_type: enum

[1, 2, 3, 8]

Тип точки

• 1 — Загрузка
• 2 — Разгрузка

contact_persons:[{...}]

Список контактов (не более 10 контактов)

name: string

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

phone: string

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

ordinal_id: int32

Порядковый номер добавления контактного лица (от 1 до 10)

}]

note: string

Примечание (до 1000 символов)

timeslots_warehouse_id: int32 (nullable)

Айди склада из временных окон

}]

Пример

[...]

{...}

"deal_point_id":"2fb965f2-85e9-4213-90e7-f396e47219e7",

"ordinal_id":1,

"time":"10:00",

"date":"2.1.2019",

"time_to":"1:00",

"date_to":"13.2.2019",

"lat":30.3330562,

"lon":59.974006,

"address":"гор. Санкт-Петербург",

"city_id":0,

"region_id":0,

"country_id":0,

"point_type":0,

"contact_persons":[...],

{...}

"name":"string",

"phone":"string",

"ordinal_id":1

}

],

"note":"string",

"timeslots_warehouse_id":0

}

]

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

Модель

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Консоль

Отправить

Параметры

dealId guid

[ { "deal_point_id": "2fb965f2-85e9-4213-90e7-f396e47219e7", "time": "10:00", "date": "02.01.2019", "time_to": "01:00", "date_to": "13.02.2019", "lat": 30.3330562, "lon": 59.974006, "address": "гор. Санкт-Петербург", "contact_persons": [ { "name": "string", "phone": "string", "ordinal_id": 1 } ], "note": "string", "timeslots_warehouse_id": 0 } ]

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

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

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

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

Модель и примеры

Запрос

Модель

[{...}]

deal_point_id*: guid

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

Id точки из Заказа

time: string

Время

date: string

Дата

time_to: string

Время до (если есть)

date_to: string

Дата до (если есть)

lat: double (nullable)

Широта точки

lon: double (nullable)

Долгота точки

address: string

Адрес

contact_persons:[{...}]

Список контактов (не более 10 контактов)

name: string

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

phone: string

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

ordinal_id: int32

Порядковый номер добавления контактного лица (от 1 до 10)

}]

note: string

Примечание (до 1000 символов)

timeslots_warehouse_id: int32 (nullable)

Айди склада из временных окон

}]

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

CURL

curl 'https://api.ati.su/v1.2/orders/carrier/{dealId}/driver_tracker_points' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[{"deal_point_id":"2fb965f2-85e9-4213-90e7-f396e47219e7","time":"10:00","date":"02.01.2019","time_to":"01:00","date_to":"13.02.2019","lat":30.3330562,"lon":59.974006,"address":"гор. Санкт-Петербург","contact_persons":[{"name":"string","phone":"string","ordinal_id":1}],"note":"string","timeslots_warehouse_id":0}]'

1C

Процедура Выполнить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}/driver_tracker_points", "[{""deal_point_id"":""2fb965f2-85e9-4213-90e7-f396e47219e7"",""time"":""10:00"",""date"":""02.01.2019"",""time_to"":""01:00"",""date_to"":""13.02.2019"",""lat"":30.3330562,""lon"":59.974006,""address"":""гор. Санкт-Петербург"",""contact_persons"":[{""name"":""string"",""phone"":""string"",""ordinal_id"":1}],""note"":""string"",""timeslots_warehouse_id"":0}]");

Ответ

200 Созданная информация по заказу

Модель

[{...}]

deal_point_id: guid

Id точки из Заказа

ordinal_id: int32

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

time: string

Время

date: string

Дата

time_to: string

Время до (если есть)

date_to: string

Дата до (если есть)

lat: double (nullable)

Широта точки

lon: double (nullable)

Долгота точки

address: string

Адрес

city_id: int32

Id города
Значение из словаря городов ATI.SU

region_id: int32

Id региона
Значение из словаря регионов ATI.SU

country_id: int32

Id страны
Значение из словаря стран ATI.SU

point_type: enum

[1, 2, 3, 8]

Тип точки

• 1 — Загрузка
• 2 — Разгрузка

contact_persons:[{...}]

Список контактов (не более 10 контактов)

name: string

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

phone: string

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

ordinal_id: int32

Порядковый номер добавления контактного лица (от 1 до 10)

}]

note: string

Примечание (до 1000 символов)

timeslots_warehouse_id: int32 (nullable)

Айди склада из временных окон

}]

Пример

[...]

{...}

"deal_point_id":"2fb965f2-85e9-4213-90e7-f396e47219e7",

"ordinal_id":1,

"time":"10:00",

"date":"2.1.2019",

"time_to":"1:00",

"date_to":"13.2.2019",

"lat":30.3330562,

"lon":59.974006,

"address":"гор. Санкт-Петербург",

"city_id":0,

"region_id":0,

"country_id":0,

"point_type":0,

"contact_persons":[...],

{...}

"name":"string",

"phone":"string",

"ordinal_id":1

}

],

"note":"string",

"timeslots_warehouse_id":0

}

]

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

Модель

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Консоль

Отправить

Параметры

dealId guid

[ { "deal_point_id": "2fb965f2-85e9-4213-90e7-f396e47219e7", "time": "10:00", "date": "02.01.2019", "time_to": "01:00", "date_to": "13.02.2019", "lat": 30.3330562, "lon": 59.974006, "address": "гор. Санкт-Петербург", "contact_persons": [ { "name": "string", "phone": "string", "ordinal_id": 1 } ], "note": "string", "timeslots_warehouse_id": 0 } ]

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

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

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

delete /v1.2/orders/carrier/{dealId}/driver_tracker_points

Модель и примеры

Запрос

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

CURL

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

1C

Процедура Выполнить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.2/orders/carrier/{dealId}/driver_tracker_points");

Ответ

200 Информация по заказу успешно удалена

Модель

binary

Пример

"binary"

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

Модель

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Консоль

Отправить

Параметры

dealId guid

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

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

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

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

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

Модель и примеры

Запрос

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

CURL

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

1C

Процедура Выполнить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"

}

Консоль

Отправить

Параметры

deal_id guid

south_west_lat double

south_west_lng double

north_east_lat double

north_east_lng double

zoom double

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

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

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

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

Модель и примеры

Запрос

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

CURL

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

1C

Процедура Выполнить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"

}

Консоль

Отправить

Параметры

deal_id guid

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

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

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

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

Модель и примеры

Запрос

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

CURL

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

1C

Процедура Выполнить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 Успешное выполнение операции

Модель

null

Пример

null

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

Модель

{...}

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

reason: string

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

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Консоль

Отправить

Параметры

dealId guid

value integer

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

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

Получение последних локаций пользователей

post /v1/driver/public/deal/users_activity

Модель и примеры

Запрос

Модель

{...}

deals:[{...}]

phone: string

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

deal_id: uuid

Id сделки в формате GUID

}]

}

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

CURL

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":"string","deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}]}'

1C

Процедура Выполнить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"":""string"",""deal_id"":""3fa85f64-5717-4562-b3fc-2c963f66afa6""}]}");

Ответ

200 Success

Модель

{...}

deals:[{...}]

deal_id: string

Id сделки в формате GUID

initial_phone: string

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

phone: string

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

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]

extended_status: enum

[none, completed_by_driver]

tracker_finished_at: date-time (nullable)

Дата и время завершения перевозки водителем

last_active: date-time (nullable)

Дата и время когда водитель последний раз заходил в приложение

has_tracker: boolean

Установлено ли приложение у водителя

last_location:{...}

lon: double

lat: double

events:[{...}]

type: enum

[not_set, meta, status, photo, other]

tag: string (nullable)

date: date-time (nullable)

date_to: date-time (nullable)

time: string (nullable)

time_to: string (nullable)

location_name:{...}

country: string (nullable)

region: string (nullable)

city: string (nullable)

address: string (nullable)

}

company_info:{...}

ati_id: string (nullable)

name: string (nullable)

}

}]

is_fake: boolean

is_disabled: boolean

is_no_data: boolean

is_power_saving: boolean

}

gps_status_date: date-time (nullable)

}]

}

Пример

{...}

"deals":[...]

{...}

"deal_id":"string",

"initial_phone":"string",

"phone":"string",

"tracker_offer_status":"none",

"reason_changing_offer_status":"string",

"status":"none",

"extended_status":"none",

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

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

"has_tracker":false,

"last_location":{...},

"lon":0.5,

"lat":0.5,

"events":[...],

{...}

"type":"not_set",

"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"

},

"company_info":{...}

"ati_id":"string",

"name":"string"

}

}

],

"is_fake":false,

"is_disabled":false,

"is_no_data":false,

"is_power_saving":false

},

"gps_status_date":"1970-01-01T00:00:00.000Z"

}

]

}

4XX Bad Request

Модель

{...}

error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}

Пример

{...}

"error_code":"validation_error",

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

}

Консоль

Отправить

Параметры

Нет параметров

{ "deals": [ { "phone": "string", "deal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ] }