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

POST /async_matrix/create_task/get_dist_matrix

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

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

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

required
Array of objects (RequestPoint) non-empty

Массив точек.

sources
required
Array of integers non-empty [ items >= 0 ]

Какие точки из массива points являются точками отправления (массив индексов).

targets
required
Array of integers non-empty [ items >= 0 ]

Какие точки из массива points являются точками прибытия (массив индексов).

string or null

Дата и время начала движения в формате RFC 3339 (например, 2020-05-15T15:52:01Z). Если параметр не указан, используется текущее время.

transport
string
Default: "driving"
Enum: "driving" "truck" "bicycle" "scooter" "walking"

Тип движения:

  • driving - автомобильный,
  • truck - грузовой транспорт,
  • bicycle - велосипедный,
  • scooter - самокатный,
  • walking - пешком,

type
string
Default: "jam"
Enum: "jam" "statistics" "shortest"

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

  • 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: []

Идентификаторы пропуска в пропускную зону (массив чисел).

boolean or null

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

Responses

Response Schema: application/json
string or null

Идентификатор задачи

string or null

Дополнительная информация о статусе задачи

TaskStatus (string) or null

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "message": "string",
  • "status": "TASK_CREATED"
}