Обзор поисковых API 2ГИС
Используйте поисковые API 2ГИС для решения задач, связанных с поиском объектов на карте или сбором информации об объектах из справочника 2ГИС.
Определить координаты объекта по адресу или наоборот поможет Geocoder API. Используйте запросы к нему в сценариях, когда нужно узнать адрес объекта через клик по карте. Или наоборот: показать на карте уже известный адрес.
Вы можете собрать информацию об интересующем объекте или найти подходящие объекты по любому критерию с помощью Places API. Объекты — это компании, здания, жилые дома, остановки транспорта, достопримечательности, парковки, перекрестки и многое другое.
Places API предоставляет доступ к полному справочнику объектов, который 2ГИС собирает и использует в своих решениях. Используйте запросы к нему в сценариях, когда нужно собрать группу объектов по определённым критериям и обработать информацию о них.
Вы можете реализовать такой же поиск и показ объектов на карте, как в самом 2ГИС:
Если вы хотите реализовать подсказчик, который будет дополнять ввод пользователя в поисковой строке, вам подойдёт Suggest API. Используйте его в веб-интерфейсах или мобильных экранах, чтобы облегчить пользователю выбор нужного адреса или объекта на картах городов.
Например, в приложении 2ГИС подсказчик работает так:
Если нужно узнать, к какой категории относится компания, используйте Categories API. Например, вы можете узнать, какие категории развлекательных заведений есть в Москве или к какому типу относится заведение «Му-Му»: кафе, столовая или ресторан.
Чтобы получить информацию о регионе на карте, используйте Regions API. Эти запросы помогут вам определить, к какому региону относится точка на карте, получить информацию о населённых пунктах в регионе, а также получить ID региона для уточнения других поисковых запросов.
А отобразить объекты в виде маркеров на карте поможет Markers API.
Подробные примеры запросов и справочники параметров представлены в документации к каждому поисковому API.
FAQ
Как начать работать с API поиска?
Чтобы работать с API, нужно получить ключ доступа:
- Зарегистрируйтесь в личном кабинете Менеджер Платформы.
- Создайте демо-ключ или купите подписку для доступа к API.
- Изучите пример запросов и ответов в документации к нужному API.
Как рассчитывается стоимость использования API?
Стоимость использования API поиска рассчитывается исходя из количества запросов. При этом часть информации об объектах (например, ИНН компании) доступна только по отдельному запросу и за дополнительную плату. См. список методов и полей с отдельной тарификацией в документации к Places API, Geocoder API и Suggest API.
Можно ли использовать API поиска бесплатно?
Вы можете оформить демо-ключ доступа для тестирования API поиска на один месяц. При использовании демо-ключа вы можете получить максимум 5 страниц с результатами ответов по 10 объектов на каждой странице.
Как отслеживать фактическое использование API-ресурсов?
Вы можете отслеживать прогресс расходования лимитов по сервисам и статистику распределения запросов в личном кабинете Менеджер Платформы. Подробнее см. в разделе Статистика.
Как контролировать потребление API-ресурсов?
Чтобы избежать преждевременного исчерпания лимитов, вы можете ограничить использование API-ресурсов вашими приложениями. В личном кабинете Менеджер Платформы доступно несколько способов настройки ограничений:
- Установить лимиты на запросы к конкретным сервисам по всем API-ключам в подписке или по отдельным ключам. Превышение лимитов заблокирует использование продукта: запросы к API будут возвращать ошибку.
- Настроить отправку уведомлений при приближении к лимитам.
Подробнее см. в разделе Управление ключами доступа.
По каким критериям можно искать объекты в справочнике?
С помощью Places API вы можете найти конкретный объект или список объектов по произвольному текстовому запросу, координатам, адресу, телефону, рубрикам и другим параметрам объекта (например, по наличию Wi-Fi). См. основные сценарии в разделе Примеры.
Как я могу ограничить область поиска?
При поиске вы можете указать административную единицу (область, город, район и т. д.), конкретный адрес или задать свою область поиска по координатам (например, радиус вокруг точки на карте, прямоугольник или произвольную область). Подробнее см. в разделе Примеры.
Какие данные о компании можно получить?
С помощью поисковых API вы можете получить основную информацию об организации: название, адрес, режим работы, координаты на карте, статистику отзывов, и другое. Некоторые данные доступны за дополнительную плату и недоступны для демо-ключа: ИНН, контактная информация, численность сотрудников, торговая лицензия и т. д. См. полный список доступных данных и условия их получения в документации к нужному API.
Как часто обновляются данные в справочнике?
Данные в справочнике 2ГИС обновляются каждый месяц и становятся доступными в ваших проектах одновременно с продуктами 2ГИС.
Можно ли добавлять собственные объекты или адреса в справочник?
Редактирование справочника 2ГИС возможно только через внутренние процессы компании 2ГИС. Если вы хотите добавить информацию о своём бизнесе в справочник 2ГИС, воспользуйтесь сервисом 2ГИС для бизнеса.
Нет ответа на мой вопрос
Воспользуйтесь поиском по документации или отправьте электронное письмо на api@2gis.ru.