Обзор решения
API-платформа для сервера — набор сервисов для работы с данными 2ГИС в вашей инфраструктуре и управления API-ключами и лицензией.
Особенности решения:
- работа в приватной сети без доступа к интернету — доступ в интернет нужен только нескольким служебным сервисам;
- самостоятельный выпуск и отзыв API-ключей для контроля доступа к продуктам;
- горизонтальное и вертикальное масштабирование.
Сервисы работают в кластере Kubernetes: они обновляются через Helm без ручной настройки зависимостей и запускаются в нескольких репликах для отказоустойчивости, а Ingress балансирует входящие запросы. Кеширование на разных архитектурных уровнях сокращает время обработки запросов.
К компонентам API-платформы для сервера относятся базовые сервисы и API-платформа. Их установка также необходима для работы продуктов 2ГИС Про и 2ГИС Ситискан.
Базовые сервисы
Базовые сервисы обязательны для работы других компонентов программного комплекса 2ГИС — установите их до установки других компонентов.
Сервис лицензий
Сервис лицензий отвечает за получение и проверку лицензии на использование установленных сервисов.
См. подробнее:
Сервис API-ключей
Сервис API-ключей отвечает за управление доступом конечных пользователей к установленным сервисам.
См. подробнее:
API-платформа
API-платформа — набор RESTful API для работы с данными и функциями, доступными в 2ГИС. Она позволяет интегрировать карты, справочник и навигацию 2ГИС в ваши приложения и сервисы.
Сервис сбора статистики
Сервис сбора статистики принимает, обрабатывает и сохраняет данные об использовании 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 Directions API | Строит маршруты для грузового транспорта с учётом параметров автомобиля и действующих дорожных ограничений. |
| Pairs Directions API | Строит несколько маршрутов за один запрос. |
| Distance Matrix API | Рассчитывает расстояние и время в пути для множества точек. Это позволяет найти точки с необходимым временем достижения. |
| TSP API | Решает задачу коммивояжёра (TSP/VRP): строит кратчайший по времени или расстоянию маршрут обхода указанных точек. |
| Isochrone API | Определяет область, достижимую за указанное время из заданной точки для разных типов маршрутов: автомобильного, велосипедного или пешеходного. Можно определять область доставки в зависимости от заданного времени доставки и доступных курьерам способов передвижения. |
| Map Matching API | Строит автомобильный маршрут по набору точек, привязанных к автомобильным дорогам. Такой набор точек записывается транспортным средством. |
См. подробнее:
- Архитектура API для работы с навигацией
- Установка API для работы с навигацией
- Обновление API для работы с навигацией
Прокси для API пробок
Прокси для API пробок позволяет получать данные о пробках в реальном времени для сервисов программного комплекса 2ГИС, которым нужны эти данные. Установка прокси необязательна, если вам не нужны данные о пробках.
См. подробнее:
Мобильный SDK
С помощью мобильного SDK в мобильном приложении вы можете:
- отображать карту 2ГИС и взаимодействовать с ней;
- добавлять пользовательские объекты на карту (маркеры, геометрические фигуры и т. д.);
- получать информацию об объектах на карте и искать объекты в справочнике;
- строить маршруты для различных типов транспорта и запускать навигацию.
Вы можете подключить мобильный SDK для iOS, Android и Flutter к установленной API-платформе.
Для использования в закрытом контуре доступен мобильный SDK для iOS, Android и Flutter до версии 12.10 включительно.
См. подробнее:
Менеджер Платформы
Менеджер Платформы — это инструмент администратора, который позволяет:
- Проверить статус работы API.
- Загрузить пользовательские стили для карты.
- Протестировать в локальной сети ключевые API карт, поиска и навигации.
- Посмотреть статистику распределения запросов к сервисам.
См. подробнее: