iOS SDK

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

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

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

Получение ключей доступа

Для работы с SDK нужно получить файл ключа dgissdk.key с обязательным указанием appId приложения, для которого этот ключ создаётся. Ключ будет использоваться для подключения к серверам 2ГИС, получения географических данных, а также для использования офлайн-данных и навигатора. Этот ключ уникален для этого типа SDK и не может быть использован с другими SDK от 2ГИС.

Чтобы получить файл ключа, заполните форму на dev.2gis.ru.

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

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

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

Версии SDK

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

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

Важно

Использовать совместно Full и Map нельзя: это приведёт к ошибке сборки.

Установка

Swift Package Manager

Чтобы установить iOS SDK через Swift Package Manager, добавьте в проект пакетную зависимость. См. инструкции по установке Swift-пакетов в документации Apple.

Для подключения SDK укажите URL в зависимости от версии:

https://github.com/2gis/mobile-sdk-full-swift-package — для версии SDK Full.
https://github.com/2gis/mobile-sdk-map-swift-package — для версии SDK Map.

CocoaPods

Чтобы установить iOS SDK через CocoaPods, добавьте зависимость DGisMobileSDK.

Используйте версионирование из Swift Package Manager, при этом добавьте постфикс -full или -map в зависимости от необходимой версии SDK.

Спецификацию пода вы можете посмотреть по одному из следующих URL:

https://github.com/2gis/mobile-sdk-full-swift-package/blob/master/DGisMobileSDK.podspec — для версии SDK Full.
https://github.com/2gis/mobile-sdk-map-swift-package/blob/master/DGisMobileSDK.podspec — для версии SDK Map.

Бинарный артефакт

Вы можете загрузить фреймворки напрямую, не используя пакетные менеджеры. Для этого обратитесь к репозиторию, содержащему спецификацию пакетов для CocoaPods или Swift Package Manager:

https://github.com/2gis/mobile-sdk-full-swift-package — для версии SDK Full.
https://github.com/2gis/mobile-sdk-map-swift-package — для версии SDK Map.

В файле Package.swift будет указан URL, ведущий на загрузку архива с SDK по прямой ссылке. Для навигации по версиям используйте теги git.

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

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