Regions API

Regions API используется для определения региона, где будет осуществлён поиск. Следует использовать только во внутренних системах.

Важно! В терминах справочного API регион - это участок суши, удобный для работы внутренней системы. Он никак не связан с субъектами Федерации. Регион чаще всего включает в себя крупный город или несколько и города-спутники.

Для работы с местами и компаниями за границами регионов следует использовать геоограничения.

Пример запроса и ответа

В примере выполняется поиск категории по запросу«кафе».

https://catalog.api.2gis.ru/2.0/region/search?q=Москва&key=YOUR_KEY

Не забудьте заменить YOUR_KEY на ваш ключ API (см. Как начать работать с API).

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

{
    "meta": {
        "api_version": "2.0.448950",
        "code": 200,
        "issue_date": "20200629"
    },
    "result": {
        "items": [
            {
                "id": "32",
                "name": "Москва",
                "type": "region"
            }
        ],
        "total": 1
    }
}

Как использовать

Ниже представлен пример работы с Regions API.

Определение зоны поиска из пользовательского запроса "Москва":

https://catalog.api.2gis.ru/2.0/region/search?q=Москва&key=YOUR_KEY

Поиск категории с указанием зоны поиска:

https://catalog.api.2gis.ru/2.0/catalog/rubric/search?q=кафе&region_id=32&key=YOUR_KEY

Поиск филиалов в найденной рубрике:

https://catalog.api.2gis.ru/3.0/items?rubric_id=162&sort_point=37.622161%2C55.751597&key=YOUR_KEY

Начало работы

Получите ключ. Для этого заполните анкету.
Изучите формат запроса и формат ответа.