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

Routing API

Спецификация OpenAPI

2GIS Navigation API (6.0.0)

Маршрут на автомобиле

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

Построение маршрута из нескольких точек для разного типа транспорта.

query Parameters
key
required
string

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

Request Body schema: */*
required

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

One of
required
Array of objects (RequestPoint)
RouteMode (string) or null
TrafficMode (string) or null
TransportType (string) or null
OutputType (string) or null
integer or null <long>

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

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

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

Array of objects (ExcludeObject)

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

Locale (string) or null
Params (object) or null
integer or null
Default: 1

Количество альтернативных маршрутов, которые будут построены в дополнение к основному.

boolean or null

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

boolean or null

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

Responses

Response Schema: application/json
One of
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 км,

required
object (RoutingRequestModel)

Запрос Routing API.

type
required
string (ResponseType)
Enum: "result" "error"

Тип ответа:

  • result - Успешный результат,
  • error - Ошибка,

string or null

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

Array of ResultItem (objects) or null

Response samples

Content type
application/json
Example
{
  • "status": "OK",
  • "query": {
    • "exclude": [
      ],
    • "locale": "ru",
    • "need_altitudes": true,
    • "points": [
      ],
    • "route_mode": "fastest",
    • "traffic_mode": "jam",
    • "transport": "driving"
    },
  • "type": "result",
  • "message": "string",
  • "result": [
    • {
      }
    ]
}