Помощь
Чат для вопросов по API
Мгновенно ответим на ваши вопросы
api@ati.su
Электронная почта техподдержки
Тикетная система
Оставить заявку на отдел
«Консультанты по интеграции (API)»
api.ati.su - заказы, торги, площадки
Наш телеграм-канал
Код в АТИ:
Выход

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

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

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

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

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

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

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

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

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

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

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

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

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

 
Добавить или обновить gps устройство
post
/v1/driver/public/gps/device
Развернуть все Свернуть все
{...}
name: string (nullable)

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

description: string (nullable)

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

device_id: string (nullable)

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

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Ок
Развернуть все Свернуть все
201 Создан новый объект
Развернуть все Свернуть все
4XX Ошибка запроса
Развернуть все Свернуть все
Пример Модель
{...}
"error_code":"validation_error",
"reason":"Ошибка валидации полей phone и device_id"
}
{...}
error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Удалить gps устройство
delete
/v1/driver/public/gps/device
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Ок
Развернуть все Свернуть все
4XX Ошибка запроса
Развернуть все Свернуть все
Пример Модель
{...}
"error_code":"validation_error",
"reason":"Ошибка валидации полей phone и device_id"
}
{...}
error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получить gps устройство по device_id
get
/v1/driver/public/gps/device_info
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Ок
Развернуть все Свернуть все
401 Ошибка авторизации
Развернуть все Свернуть все
404 Девайс не найден
Развернуть все Свернуть все
Пример Модель
{...}
"error_code":"validation_error",
"reason":"Ошибка валидации полей phone и device_id"
}
{...}
error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}
4XX Ошибка запроса
Развернуть все Свернуть все
Пример Модель
{...}
"error_code":"validation_error",
"reason":"Ошибка валидации полей phone и device_id"
}
{...}
error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получить все gps устройства контакта
get
/v1/driver/public/gps/all_devices
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Ок
Развернуть все Свернуть все
4XX Ошибка запроса
Развернуть все Свернуть все
Пример Модель
{...}
"error_code":"validation_error",
"reason":"Ошибка валидации полей phone и device_id"
}
{...}
error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Записать координаты
post
/v1/driver/public/gps/coordinates
Развернуть все Свернуть все
{...}
deal_id: uuid
device_id: string (nullable)
}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Ок
Развернуть все Свернуть все
4XX Ошибка запроса
Развернуть все Свернуть все
Пример Модель
{...}
"error_code":"validation_error",
"reason":"Ошибка валидации полей phone и device_id"
}
{...}
error_code: string (nullable)

Код ошибки

reason: string (nullable)

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

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получение информации о пройденном маршруте АТИ Водителя
get
/v1.2/orders/carrier/map_route/by_deal
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Информация для карты
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"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
}
]
}
]
}
]
[{...}]
}]
4XX Ошибка запроса. Подробнее про ошибки API
Развернуть все Свернуть все
Пример Модель
{...}
"reason":"string",
"error":"string"
}
{...}

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

reason: string

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

error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получение истории
get
/v1.2/orders/carrier/map/history
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 История выполнения заказа водителем
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"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
Развернуть все Свернуть все
Пример Модель
{...}
"reason":"string",
"error":"string"
}
{...}

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

reason: string

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

error: string

Ключ ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...