Обзор
API-платформа — это набор RESTful API для работы с данными и функциями, доступными в 2ГИС. Она позволяет интегрировать возможности 2ГИС (карты, справочник и навигацию) в ваши приложения и сервисы.
Установка API-платформы также необходима для работы продуктов 2ГИС Про и 2ГИС Ситискан.
В состав API-платформы входят следующие группы сервисов:
Сервис сбора статистики
Сервис сбора статистики принимает, обрабатывает и сохраняет данные об использовании API-ключей сервисами карт, поиска и навигации. Это необязательный сервис для работы API-платформы, но если вы хотите получать статистику по использованию API-ключей, сервис нужно установить до установки API ниже.
См. подробнее:
- Архитектура сервиса сбора статистики
- Установка сервиса сбора статистики
- Обновление сервиса сбора статистики
API карт
После установки API-платформы конечные пользователи смогут использовать следующие API для работы с картами:
| Реализуемое API | Описание |
|---|---|
| MapGL JS API | Позволяет интегрировать на сайт или в веб-приложение трехмерную интерактивную карту на WebGL-движке. |
См. подробнее:
- Архитектура API для работы с картами
- Установка API для работы с картами
- Обновление API для работы с картами
API поиска
После установки API-платформы конечные пользователи смогут использовать следующие API для работы с поиском:
| Реализуемое API | Описание |
|---|---|
| Places API | Ищет по различным критериям организации, здания и места. |
| Geocoder API | Определяет координаты объекта по его адресу (прямой геокодинг) и наоборот (обратный геокодинг). Также предоставляет сведения об объекте. |
| Suggest API | Предлагает подсказки при вводе, подходящие под заданные критерии поиска. |
| Categories API | Предоставляет информацию о категориях. Категория — это группа, объединяющая компании по сферам деятельности. Также предоставляет информацию о родительских и дочерних сферах деятельности для выбранной организации. Используется совместно с Places API. |
| Regions API | Позволяет выбрать территорию (города и ближайших населенных пунктов). Полученный идентификатор территории затем можно использовать в других API, чтобы ограничить область, в границах которой будет выполняться поиск организаций, зданий и мест. |
См. подробнее:
- Архитектура API для работы с поиском
- Установка API для работы с поиском
- Обновление API для работы с поиском
API навигации
После установки API-платформы (в зависимости от конфигурации компонентов) конечные пользователи смогут использовать следующие API навигации:
| Реализуемое API | Описание |
|---|---|
| Routing API | Строит автомобильные, пешеходные, велосипедные, грузовые маршруты, а также маршруты для такси и экстренных служб. |
| Directions API | Строит автомобильные, велосипедные и пешеходные маршруты. |
| Truck Direction API | Строит автомобильные маршруты для грузового транспорта с учётом параметров автомобиля и действующих дорожных ограничений. |
| Pairs Direction API | Строит несколько маршрутов за один вызов. |
| Distance Matrix API | Рассчитывает расстояние и время в пути для множества точек. Это позволяет найти точки с необходимым временем достижения. |
| Map Matching API | Строит автомобильный маршрут по набору точек, привязанных к автомобильным дорогам. Такой набор точек записывается транспортным средством. |
| Isochrone API | Определяет область, достижимую за указанное время из заданной точки для разных типов маршрутов: автомобильного, велосипедного или пешеходного. Например, с помощью этого API можно определять область доставки в зависимости от заданного времени доставки и доступных курьерам способов передвижения. |
| Public Transport API | Строит маршруты проезда на общественном транспорте. |
| TSP API | Строит оптимальный маршрут обхода указанных точек с помощью одного или нескольких курьеров. |
См. подробнее:
- Архитектура API для работы с навигацией
- Установка API для работы с навигацией
- Обновление API для работы с навигацией
Прокси для API пробок
Прокси для API пробок позволяет получать данные о пробках в реальном времени для сервисов программного комплекса 2ГИС, которым нужны эти данные. Установка прокси необязательна, если вам не нужны данные о пробках.
См. подробнее:
Мобильный SDK
Вы можете подключить мобильный SDK для iOS, Android и Flutter к установленной API-платформе. С помощью мобильного SDK вы можете реализовать в мобильном приложении следующие функции:
- Отображение карты 2ГИС и взаимодействие с ней.
- Добавлять пользовательские объекты на карту (маркеры, геометрические фигуры и т. д.).
- Получать информацию об объектах на карте и искать объекты в справочнике.
- Строить маршруты для различных типов транспорта и запускать навигацию.
См. подробнее:
Менеджер Платформы
Менеджер Платформы — это инструмент администратора, который позволяет:
- Проверить статус работы API.
- Загрузить пользовательские стили для карты.
- Протестировать в локальной сети ключевые API карт, поиска и навигации.
См. подробнее: