Быстрый старт

Быстрый старт поможет вам начать работу с сервисом и познакомиться с его возможностями.

Пройдя все шаги быстрого старта, вы:

Узнаете, как воспользоваться Routing API.
Отправите запрос на построение автомобильного маршрута через несколько точек.

Пример запроса приведён с использованием cURL.

1. Получите API-ключ

Зарегистрируйтесь в личном кабинете Platform Manager.
Создайте демо-ключ (если вы еще не пользовались продуктами 2ГИС) или запросите боевой ключ по ссылке для связи с менеджером на вкладке Ключи API.

В личном кабинете вы также можете:

Просматривать информацию по своим уже созданным ключам: какие сервисы подключены, какой лимит задан по каждому из них, когда ключ будет деактивирован.
Задавать ограничения на ключ по HTTP-заголовкам или по IP и подсетям.
Изучать статистику распределения запросов по каждому ключу.

2. Отправьте запрос

Чтобы проложить автомобильный маршрут через несколько точек, отправьте POST-запрос на /routing/7.0.0/global. Для этого:

В строке запроса укажите значение API-ключа для параметра key:
```
http://routing.api.2gis.com/routing/7.0.0/global?key=API_KEY
```

В теле запроса передайте JSON с необходимыми параметрами:

{
    "points": [
        {
            "type": "stop",
            "lon": 37.582591,
            "lat": 55.775364
        },
        {
            "type": "stop",
            "lon": 37.579206,
            "lat": 55.774362
        }
    ],
    "locale": "ru",
    "transport": "car",
    "route_mode": "fastest",
    "traffic_mode": "jam"
}

Более подробная информация о параметрах в Справочнике API.

Пример запроса:

curl --location --request POST 'http://routing.api.2gis.com/routing/7.0.0/global?key=API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "points": [
        {
            "type": "stop",
            "lon": 37.582591,
            "lat": 55.775364
        },
        {
            "type": "stop",
            "lon": 37.579206,
            "lat": 55.774362
        }
    ],
    "locale": "ru",
    "transport": "car",
    "route_mode": "fastest",
    "traffic_mode": "jam"
}'

Пример ответа:

response.json

{
    "query": {
        "locale": "ru",
        "points": [
            {
                "lat": 55.775364,
                "lon": 37.582591,
                "type": "stop"
            },
            {
                "lat": 55.774362,
                "lon": 37.579206,
                "type": "stop"
            }
        ],
        "route_mode": "fastest",
        "traffic_mode": "jam",
        "transport": "car"
    },
    "result": [
        {
            "algorithm": "с учётом пробок",
            "begin_pedestrian_path": {
                "geometry": {
                    "selection": "LINESTRING(37.582590 55.775363, 37.583086 55.775486)"
                }
            },
            "end_pedestrian_path": {
                "geometry": {
                    "selection": "LINESTRING(37.579375 55.774203, 37.579206 55.774362)"
                }
            },
            "filter_road_types": ["highway"],
            "id": "12891185604926644622",
            "maneuvers": [
                {
                    "comment": "start",
                    "icon": "start",
                    "id": "13961056498835124274",
                    "outcoming_path": {
                        "distance": 30,
                        "duration": 8,
                        "geometry": [
                            {
                                "color": "fast",
                                "length": 56,
                                "selection": "LINESTRING(37.583086 55.775486, 37.583150 55.775405, 37.583239 55.775297, 37.583253 55.775281, 37.583307 55.775231)",
                                "style": "normal"
                            }
                        ],
                        "names": ["Грузинский Вал"]
                    },
                    "outcoming_path_comment": "30 м прямо",
                    "type": "begin"
                },
                {
                    "comment": "Поворот направо на ул. Грузинский Вал",
                    "icon": "crossroad_right",
                    "id": "6015121566123915635",
                    "outcoming_path": {
                        "distance": 329,
                        "duration": 102,
                        "geometry": [
                            {
                                "color": "normal",
                                "length": 595,
                                "selection": "LINESTRING(37.583307 55.775231, 37.583032 55.775138, 37.581347 55.774564, 37.580879 55.774404, 37.580612 55.774313, 37.580302 55.774207, 37.579955 55.774089, 37.579792 55.774034, 37.579402 55.773901, 37.579271 55.773856, 37.578973 55.773755, 37.578732 55.773673)",
                                "style": "normal"
                            }
                        ],
                        "names": ["Грузинский Вал"]
                    },
                    "outcoming_path_comment": "350 м прямо",
                    "turn_angle": 89,
                    "turn_direction": "right",
                    "type": "crossroad"
                },
                {
                    "comment": "Поворот направо",
                    "icon": "crossroad_right",
                    "id": "3868045316290609245",
                    "outcoming_path": {
                        "distance": 94,
                        "duration": 25,
                        "geometry": [
                            {
                                "color": "ignore",
                                "length": 169,
                                "selection": "LINESTRING(37.578732 55.773673, 37.578554 55.773830, 37.578479 55.773898, 37.578702 55.773974, 37.579107 55.774112, 37.579313 55.774182, 37.579375 55.774203)",
                                "style": "normal"
                            }
                        ],
                        "names": []
                    },
                    "outcoming_path_comment": "90 м прямо",
                    "turn_angle": 89,
                    "turn_direction": "right",
                    "type": "crossroad"
                },
                {
                    "comment": "finish",
                    "icon": "finish",
                    "id": "17223433631698559069",
                    "outcoming_path_comment": "Вы на месте!",
                    "type": "end"
                }
            ],
            "reliability": 1.0,
            "route_id": "moscow-cr-mosesd.m9/carrouting/1686122283.416025",
            "total_distance": 453,
            "total_duration": 136,
            "type": "carrouting",
            "ui_total_distance": {
                "unit": "м",
                "value": "450"
            },
            "ui_total_duration": "2 мин",
            "waypoints": [
                {
                    "original_point": {
                        "lat": 55.77548696452943,
                        "lon": 37.58308657528283
                    },
                    "projected_point": {
                        "lat": 55.77548696452943,
                        "lon": 37.58308657528283
                    },
                    "transit": false
                },
                {
                    "original_point": {
                        "lat": 55.77420397246263,
                        "lon": 37.57937599417024
                    },
                    "projected_point": {
                        "lat": 55.77420397246263,
                        "lon": 37.57937599417024
                    },
                    "transit": false
                }
            ]
        }
    ],
    "type": "result"
}

Что дальше?

Узнайте о возможностях Routing API.
Примеры работы Routing API.
Справочник API.