Truck Directions API
Truck Directions API позволяет построить маршрут для грузового транспорта, не включая улицы с действующими ограничениями для грузового транспорта.
Truck Directions API при построении маршрута для грузового транспорта учитывает:
- габариты и массу автомобиля;
- максимально разрешённую массу на маршруте;
- ограничения на движение с опасными и взрывчатыми грузами;
- ограничения знаками 3.4 «Движение грузовых автомобилей запрещено» и 3.2 «Движение запрещено» в сочетании с табличками 8.4.1 «Вид транспортного средства», 8.11 «Ограничение разрешённой максимальной массы» (2,5 тонны ) и 8.3.1–8.3.2 «Направление действия».
- пробки в реальном времени или статистику пробок;
- грунтовые и платные дороги и предлагает маршрут в объезд таких дорог, если пользователь выбрал такую настройку.
Truck Directions API при построении маршрута может в частности:
- возвращать информацию о высотах по маршруту. См. раздел Высоты для подробной информации.
- возвращать точки на маршруте. См. раздел Точки на маршруте для подробной информации.
Список регионов, в которых можно строить маршруты для грузового транспорта, постепенно дополняется новыми городами.
На видео представлен пример построения маршрута для грузового транспорта с учётом ограничений на габариты автомобиля.
На видео представлен пример построения маршрута для грузового автомобиля в объезд улиц, по которым запрещено движение грузового транспорта.
Получение ключа
Для доступа к API нужен специальный ключ. Чтобы его получить, заполните форму по адресу dev.2gis.ru/order.
Пример запроса
Чтобы проложить маршрут, нужно отправить POST-запрос на endpoint /truck/6.0.0/global
. В строке запроса укажите ваш ключ API в качестве значения параметра key
.
https://routing.api.2gis.com/truck/6.0.0/global?key=API_KEY
Координаты точек маршрута и другие параметры нужно передать в виде JSON в теле запроса.
Например, чтобы построить маршрут для грузового транспорта из точки A в точку B с учётом текущих пробок, можно отправить следующий запрос:
curl --request POST \
--url 'https://routing.api.2gis.com/truck/6.0.0/global?key=API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"points": [
{
"type": "walking",
"x": 82.93057,
"y": 54.943207
},
{
"type": "walking",
"x": 82.945039,
"y": 55.033879
}
],
"type": "truck_jam"
}'
Массив points
содержит координаты точек маршрута (x
- долгота, y
- широта). Первый элемент в массиве является точкой отправления.
Пример ответа
Запрос вернет объект, включающий длину маршрута в метрах (total_distance
), время в пути в секундах (total_duration
), список манёвров (maneuvers
) и другие поля. Информацию о каждом поле можно посмотреть в Справочнике API.
{
"query": {
"points": [
{
"type": "walking",
"x": 82.93057,
"y": 54.943207
},
{
"type": "walking",
"x": 82.945039,
"y": 55.033879
}
],
"type": "truck_jam"
},
"result": [
{
"algorithm": "с учётом пробок",
"begin_pedestrian_path": {...},
"end_pedestrian_path": {...},
"filter_road_types": [...],
"id": "1805336109018823561",
"maneuvers": [...],
"route_id": "...",
"total_distance": 15153,
"total_duration": 2204,
"type": "truckrouting",
"ui_total_distance": {},
"ui_total_duration": "36 мин",
"waypoints": [...]
}
],
"type": "result"
}
Параметры грузового автомобиля
Чтобы построить маршрут с учётом грузовых ограничений, нужно указать характеристики груза и транспорта при помощи параметра truck_params
. В случае, если какая-либо характеристика не указана, будет использовано значение по умолчанию.
{
"points": [...],
"truck_params": {
"max_perm_mass": 10,
"mass": 9,
"axle_load": 4,
"height": 3.2,
"width": 2.5,
"length": 7,
"dangerous_cargo": true,
"explosive_cargo": true
}
}
Полный список учитываемых характеристик и значения по умолчанию можно посмотреть в Справочнике API.
Типы маршрутов
Кратчайший по времени
По умолчанию прокладывается кратчайший по времени маршрут для грузового транспорта с учётом текущих пробок. Чтобы построить другой тип маршрута, нужно указать в запросе поле type
.
{
"points": [...],
"type": "truck_jam" // маршрут для грузового транспорта по текущим пробкам
}
Вместо текущих пробок можно использовать статистическую информацию по пробкам. Для этого нужно указать тип маршрута truck_statistic
и нужную дату-время в виде Unix-времени в поле utc
.
{
"points": [...],
"type": "truck_statistic", // маршрут для грузового транспорта на основе статистических данных по пробкам...
"utc": 1606826131 // ...на 1 декабря 2020 года, 12 часов UTC
}
Кратчайший по расстоянию
Чтобы построить самый короткий маршрут, даже если он не является оптимальным по времени из-за пробок, нужно указать тип truck_shortest
.
{
"points": [...],
"type": "truck_shortest" // маршрут для грузового транспорта без учёта пробок
}
Исключение типов дорог
При построении маршрута можно исключить определенные типы дорог, такие как грунтовые или платные. Чтобы это сделать, нужно указать в запросе поле filters
.
{
"points": [...],
"filters": ["dirt_road"] // исключить из маршрута грунтовые дороги
}
Список возможных значений для поля filters
можно посмотреть в Справочнике API.
Высоты
Получение высот и информации по высотам на маршруте включается флагом need_altitudes
.
{
"alternative": 0,
"locale": "ru",
"point_a_name": "Source",
"point_b_name": "Target",
"type": "truck_jam",
"points": [
{
"start": true,
"type": "walking",
"x": 82.93057,
"y": 54.943207
},
{
"start": false,
"type": "walking",
"x": 82.945039,
"y": 55.033879,
"object_id": "141476222741292"
}
],
"need_altitudes": true
}
При этом ответ будет содержать:
- статистику по высотам (максимальная/минимальная высота, набор/спад высоты, максимальный угол)
altitudes_info
{
"altitudes_info": {
"elevation_gain": 12440,
"elevation_loss": 11020,
"max_altitude": 10700,
"max_road_angle": 8,
"min_altitude": 6600
}
}
- у геометрий появится массив углов сегментов геометрии
angles
- у точек геометрии появится третья координата (высота над уровнем моря в см)
{
"geometry": [
{
"angles": "LINESTRING(1, -1)",
"color": "ignore",
"length": 22,
"selection": "LINESTRING(82.930722 54.943655 9200, 82.930815 54.943650 9220, 82.930926 54.943640 9190)",
"style": "normal"
}
]
}
Точки на маршруте
Если на маршруте есть точки особого типа, то в ответе будет содержаться массив точек на маршруте. Например, на маршруте есть участок платной дороги. Для этого участка в ответе в массиве точек на маршруте формируются две точки (начала и конца платного участка).
{
"route_points": [
{
"coordinates": {
"lat": 55.73942822546596,
"lon": 37.37259908712576
},
"distance": 746,
"type": "TollRoadBegin"
},
{
"coordinates": {
"lat": 55.71525675255834,
"lon": 37.31850882892307
},
"distance": 5784,
"type": "TollRoadEnd"
}
]
}