Get Started

This section helps developers quickly get started with the Map SDK. It covers the prerequisites, requirements, and installation steps needed to set up the SDK. It also includes a Quickstart guide for building a simple application, allowing developers to explore the Map SDK in action and understand its core capabilities.

---

Prerequisites and requirements

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

• Access Key: an API key issued during onboarding - see Contact us to request access.
• IDE (Android Studio): to build and develop the Android application. Use the latest stable Android Studio version recommended by Google.
• Android SDK levels
  • minSdkVersion 24
  • targetSdkVersion 36
  • compileSdkVersion 36
• Use the Google Play services location version compatible with your project and this SDK release. Refer to the latest release notes for the recommended version.

---

Import library from Sovereign Solutions Artifacts

Add the Sovereign Solutions Artifacts repository to your root settings.gradle or settings.gradle.kts:

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://artifact.sovereignsolutions.tech/artifactory/ssmap-android/")
            credentials {
                username = "YOUR_ARTIFACT_USERNAME" // Replace with your artifact registry username
                password = "YOUR_ARTIFACT_TOKEN" // Replace with your artifact registry token
            }
        }
    }
}

Then add the library dependency to your app-level build.gradle or build.gradle.kts:

dependencies {
    implementation("com.sovereignsolutions:ssmap-android:0.0.2")
}

---

Next steps

• Show Map - initialize the SDK with an API key and render your first map
• 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 Android Tracking SDK.