Перейти к основному содержимому

Pairs Directions API (limited)

Метод доступен только при установке API-платформы 2ГИС в закрытом контуре (On-Premise).

Спецификация OpenAPI
API docs by Redocly

2GIS Navigation API (6.0.0)

Алгоритмы

Построение нескольких маршрутов по парам точек

Позволяет за один вызов рассчитать несколько маршрутов. Каждый маршрут может состоять только из двух точек.

path Parameters
routing_type
required
string
Enum: "driving" "walking" "taxi" "bicycle" "motorcycle"

Тип маршрутизации:

  • driving - автомобильный маршрут
  • walking - пешеходный маршрут
  • taxi - автомобильный маршрут c учётом полос общественного транспорта
  • bicycle - велосипедный маршрут
  • motorcycle - маршрут на мотоцикле
"

query Parameters
key
required
string

API-ключ разработчика

Request Body schema: */*
required

Параметры запроса

required
Array of objects (RequestPoints)

Массив маршрутов (пар точек). Может содержать до 50 маршрутов.

type
required
string (RequestType)
Enum: "jam" "statistics" "shortest"

Тип маршрута:

  • jam - кратчайший по времени с учётом текущих пробок,
  • statistics - кратчайший по времени с учётом статистических данных по пробкам,
  • shortest - кратчайший по расстоянию,

Array of RequestFilter (strings) or RequestFilter (string) or null
boolean or null

Если true, при построении маршрута могут использоваться перекрытые дороги.

OutputType (string) or null
integer or null <long>

Дата и время, на которые производится расчёт маршрута (при использовании типов маршрута statistics и shortest). Указывается как Unix-время.

Array of objects (ExcludeObject)

Набор исключаемых областей, которые следует избегать при построении маршрута. Не более 25.

boolean or null

Если true, в ответ будет добавлена информация о стоимости проезда по платным дорогам.

Responses

Response Schema: application/json
Array
status
required
string (StatusType)
Enum: "OK" "FAIL" "POINT_EXCLUDED" "ROUTE_NOT_FOUND" "ROUTE_DOES_NOT_EXISTS" "ATTRACT_FAIL"

Статус обработки запроса:

  • OK - маршрут построен успешно,
  • FAIL - неизвестная ошибка построения маршрута,
  • POINT_EXCLUDED - точки попали в зону исключения,
  • ROUTE_NOT_FOUND - маршрут не удалось построить на текущих данных дорожного графа,
  • ROUTE_DOES_NOT_EXISTS - маршрут между точками на дорожном графе не существует,
  • ATTRACT_FAIL - не удалось притянуть точки к дорожному графу: одна из точек маршрута удалена от дорожного графа более, чем на 10 км,

integer or null

Длина маршрута в метрах.

integer or null

Время в пути в секундах.

lat1
required
number <double> >= 0

Широта точки отправления.

lon1
required
number <double> >= 0

Долгота точки отправления.

lat2
required
number <double> >= 0

Широта точки прибытия.

lon2
required
number <double> >= 0

Долгота точки прибытия.

number or null

Точность маршрута в виде числа от 0 до 1 (если был указан параметр distance_direction).

boolean or null

Если true, часть маршрута проходит по перекрытым дорогам.

string or null

Сообщение об ошибке

string or null

Геометрия маршрута в формате WKT, если в запросе указана полная выдача. Пустая строка, если указана упрощенная выдача.

Array of RoutePayment (objects) or null

Response samples

Content type
application/json
[
  • {
    • "distance": 10838,
    • "duration": 1505,
    • "lat1": 55.102268,
    • "lat2": 55.032594,
    • "lon1": 82.933328,
    • "lon2": 82.958722,
    • "status": "OK"
    },
  • {
    • "distance": 14586,
    • "duration": 1956,
    • "lat1": 55.079794,
    • "lat2": 54.981836,
    • "lon1": 82.92952,
    • "lon2": 82.907189,
    • "status": "OK"
    }
]