iOS SDK

iOS SDK позволяет добавить карту 2ГИС в ваше iOS-приложение. С помощью SDK можно отобразить карту на экране, получать информацию об объектах карты, строить маршруты, использовать навигатор и т. д.

Примеры использования SDK см. в разделе Примеры. Описание всех классов и методов см. в разделе Справочник API.

Картографические данные поддерживают стандарты OGC.

Версии SDK

Пакеты iOS SDK доступны в двух версиях:

• Full — полная версия, которая позволяет:
  • Добавлять карту в приложение и управлять ей: добавлять маркеры и геометрические фигуры, управлять движением камеры, отображать слои (например, пробки), работать со стилями карты и т. д.
  • Искать объекты в справочнике: организации, здания, места и другие.
  • Работать с навигатором в приложении в трёх режимах: свободная навигация, ведение по маршруту и симуляция ведения.
  • Строить оптимальные маршруты на карте, в том числе внутри зданий.
  • Использовать офлайн-данные.
• Map — облегчённая версия, которая позволяет:
  • Добавлять карту в приложение и управлять ей: добавлять маркеры и геометрические фигуры, управлять движением камеры, отображать слои (например, пробки), работать со стилями карты и т. д.
  • Искать объекты в справочнике: организации, здания, места и другие.

предупреждение

Не используйте версии Full и Map вместе: это приведёт к ошибке сборки.

API для работы SDK

В зависимости от нужных функциональностей, для работы SDK требуются ключи доступа к API карт, поиска и навигации. Доступные возможности зависят от версии SDK: Full или Map.

При использовании ключа оплачивается только доступ к используемым API, в зависимости от количества отправленных запросов (и в некоторых случаях — полученных ответов). Вы можете работать с ключами в личном кабинете Менеджер Платформы.

Карта (для Full и Map)

Подробнее о доступных возможностях см. в инструкции Карта.

Функциональность	API
Создание карты в приложении (метод makeMapFactory())	Map Tiles API Regions API
Отображение пробок на карте (класс TrafficSource)	Regions API

Справочник (для Full и Map)

Подробнее о доступных возможностях см. в инструкции Справочник.

Функциональность	API
Создание поискового движка (класс SearchManager)	Regions API
Получение результатов поиска (метод SearchManager.search())	Places API Markers API Получение некоторой информации об объектах в доступно только при дополнительной настройке ключа за отдельную плату: см. раздел Структура данных объекта.
Поиск объектов в справочнике по идентификатору (метод SearchManager.searchById())	Places API Markers API
Формирование поисковых подсказок (метод SearchManager.suggest())	Suggest API

Маршруты (только для Full)

Подробнее о доступных возможностях см. в инструкции Маршруты.

Функциональность	API
Поиск оптимального маршрута с учётом пробок (класс TrafficRouter)	Directions API — все маршруты, кроме общественного транспорта. Routing API — маршруты общественного транспорта. Truck Directions API — зоны движения грузовиков по пропускам.
Отображение маршрутов на карте (класс RouteEditorSource)	Directions API — все маршруты, кроме общественного транспорта. Routing API — маршруты общественного транспорта. Truck Directions API — зоны движения грузовиков по пропускам.

Навигация (только для Full)

Подробнее о доступных возможностях см. в инструкции Навигация.

Функциональность	API
Запуск навигатора (метод NavigationManager.start()): в режиме свободной навигации, в режиме ведения по маршруту.	Directions API — все маршруты, кроме общественного транспорта. Routing API — маршруты общественного транспорта. Truck Directions API — зоны движения грузовиков по пропускам.
Поиск альтернативных маршрутов (класс AlternativeRouteSelector)	Directions API — все маршруты, кроме общественного транспорта. Routing API — маршруты общественного транспорта. Truck Directions API — зоны движения грузовиков по пропускам.
Отображение дорожных событий (класс RoadEventSource)	Regions API

Требования к устройствам

• Xcode 14.
• iOS 16 и выше / iPadOS 16 и выше (это обусловлено использованием SwiftUI в проекте).

Демонстрационный проект

Демонстрационное приложение с исходным кодом см. в GitHub-репозитории.