POST /get_dist_matrix
Спецификация OpenAPI
2GIS Navigation API (6.0.0)
Получение информации о расстоянии и времени в пути между точками.
Получение информации о расстоянии и времени в пути между точками
query Parameters
key required | string API-ключ разработчика |
version required | string Default: "2.0" Версия API |
response_format | string Default: "json" Enum: "protobuf" "json" Формат ответа:
|
Request Body schema: */*
Параметры запроса
required | Array of objects (RequestPoint) non-empty Массив точек. |
sources required | Array of integers non-empty Какие точки из массива |
targets required | Array of integers non-empty Какие точки из массива |
string or null Дата и время начала движения в формате RFC 3339 (например, 2020-05-15T15:52:01Z). Если параметр не указан, используется текущее время. | |
transport | string Default: "driving" Enum: "driving" "taxi" "truck" "walking" "bicycle" Тип движения:
|
type | string Default: "jam" Enum: "jam" "statistics" "shortest" Тип маршрута:
|
Array of RequestFilter (strings) or RequestFilter (string) or null | |
boolean or null Если true, при построении маршрута могут использоваться перекрытые дороги. | |
Array of objects (ExcludeObject) Набор исключаемых областей, которые следует избегать при построении маршрута. Не более 25. | |
TruckParams (object) or null | |
number or null Ограничение средней скорости движения км/ч. | |
pass_zone_pass_ids | Array of integers Default: [] Идентификаторы пропуска в пропускную зону (массив чисел). |
Responses
Response Schema: application/json
Array of RoutesItem (objects) or null Массив найденных маршрутов. Для каждой последовательной пары точек находится ровно один маршрут.Таким образом, в случае P-P здесь будет один маршрут, а в общем случае с N точек будет N-1 маршрут |
Response samples
- 200
{- "routes": [
- {
- "status": "FAIL",
- "source_id": 0,
- "target_id": 0,
- "distance": 0,
- "duration": 0,
- "reliability": 1,
- "are_locked_roads_ignored": true
}
]
}