Skip to main content

Get Started

This section covers the prerequisites, requirements and installation steps needed to set up the Map SDK on native iOS.


Prerequisites and requirements​

The Map SDK's iOS SDK requires the following prerequisites:

  • Access Key: an API key issued during onboarding - see Contact us to request access.
  • Xcode: use the newest available version.
  • iOS deployment target
    • Minimum iOS version: 15.0
    • Target iOS version: 26+
  • CocoaPods: the SDK is distributed as a pod.

Installation​

Option A: CocoaPods​

1. Add the pod​

In ios/Podfile:

platform :ios, '15.0'

target 'Runner' do
pod 'SSMaplib',
:http => 'https://YOUR_USERNAME:[email protected]/artifactory/ssmap-ios-map/SSMaplib/0.0.1/SSMaplib-0.0.1.tar.gz'
end

post_install do |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.0'
end
end
end

2. Install​

cd ios
pod install
cd ..

3. Set deployment target to 15.0​

In Xcode, set both Runner → Targets → Runner and Runner Project build settings to iOS Deployment Target 15.0.

4. Add permissions​

In Info.plist:

<key>NSLocationWhenInUseUsageDescription</key>
<string>This app needs your location to show your current position on the map.</string>

If you also integrate the Tracking SDK, its location keys already cover this - do not duplicate the entry.

Option B: Swift Package Manager​

SSMap is also distributed as a Swift package from a private Git repository.

1. Add the package dependency​

In Xcode:

  1. Open your project -> File -> Add Package Dependencies...
  2. Enter the repository URL:
https://git.sovereignsolutions.tech/sovereignsolution/ss-mobile-sdk/ss-map-sdk-ios/ssmap
  1. Select the SSMap library and add it to your app target.

Next steps​

  • Show Map - initialize the SDK and render your first map (UIKit or SwiftUI)
  • Draw Shapes - render points, lines and polygons on the map
  • My Location - request permissions and show the user's live position
  • What Here - reverse geocode a coordinate
  • Search - text search for locations
  • Routing - find a route between two points
  • Optimize Route - sequence multiple waypoints
  • Sample apps - reference source code on GitHub

Looking for background location collection instead? See the iOS Tracking SDK.