Getting Started¶

The Mappls Maps SDK for Android empowers you to seamlessly integrate powerful, interactive maps and location services into your Android applications. Compatible with API level 21 and above, the SDK gives you access to a robust suite of mapping features and tools designed to deliver a smooth, responsive, and customizable user experience.

With support for custom map tiles, multiple layer options, and a rich set of controls and native gestures, you can build highly dynamic, map-based applications tailored to your users’ needs. The SDK efficiently manages the downloading and rendering of map tiles, letting you focus on crafting innovative and engaging solutions for our customers.

API Usage¶

To use the Mappls Maps SDK, you’ll need to obtain a valid set of license keys (available here) and adhere to the API Terms and Conditions. Please note that as per the terms, removing or obscuring the Mappls logo and copyright notice from your application is strictly prohibited.

Your SDK usage limits are detailed on your user dashboard, and are shared across all platforms. This means that API requests made from your web, Android, or iOS applications are counted collectively toward your daily usage quota.

Project Prerequisites¶

Make sure that your project meets these requirement - Target API level 21 (Lollipop) or higher - Uses Gradle version (v8.3.2 or later) - Uses Java version (v17 or later) - compileSdkVersion 35 or later - Uses Kotlin version (v1.8 or later)

Authentication ¶

To initialize and authenticate any Mappls SDK, you must include a.conf and a.olf files in your project bundle:

You can download the required files from the Auth Console

How to create an app on Mappls Console¶

Mappls Console - How to create apps

How to download config files from App from Console¶

Mappls Console - How to create apps

Setup Your Project and Add Mappls Map¶

Add Mappls Repository ¶

Add the Mappls repository to your settings.gradle or settings.gradle.kts file: #### Kotlin (settings.gradle.kts)

    pluginManagement {
        repositories {
            maven(url = "https://maven.mappls.com/repository/mappls/")
        }
    }

#### Groovy (settings.gradle)

    pluginManagement {
        repositories {
            maven {
                url 'https://maven.mappls.com/repository/mappls/'
            }
        }
    }
    dependencyResolutionManagement {  
    repositories {  
            google()  
            mavenCentral()  
            maven {  
                url 'https://maven.mappls.com/repository/mappls/'  
            }  
    }  
    }

Adding Mappls Configuration file ¶

Download Configuration files for your app (associated with Package Name and Signing Certificate SHA-256)
Add Configuration files (<appId>.a.olf and <appId>.a.conf) into the module app-level root directory of your app
Add Mappls Service Plugin as a dependency in your project level build.gradle or build.gradle.kts #### Kotlin (build.gradle.kts)

    buildscript {
        dependencies {
            classpath("com.mappls.services:mappls-services:1.0.0")
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }

#### Groovy (build.gradle)

    buildscript {
        dependencies {
            classpath 'com.mappls.services:mappls-services:1.0.0'
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }

Add Mappls Services Plugin in your app-level build.gradle or build.gradle.kts file #### Kotlin (build.gradle.kts)

    plugins {
        id("com.android.application")
        // Add the Mappls services Gradle plugin    
        id("com.mappls.services.android")
    }

#### Groovy (build.gradle)

    plugins {
        id 'com.android.application'
        // Add the Mappls services Gradle plugin
        id 'com.mappls.services.android'
    }

Import Mappls BoM ¶

Add the Android Mappls Dependency in your app level build.gradle or build.gradle.kts file #### Kotlin (build.gradle.kts)

    // Import the Mappls BoM
    implementation(platform("com.mappls.sdk:mappls-bom:2.0.0"))

    // When using the BoM, you don't specify versions in Mappls library dependencies

#### Groovy (build.gradle)

    // Import the Mappls BoM
    implementation platform('com.mappls.sdk:mappls-bom:2.0.0')

    // When using the BoM, you don't specify versions in Mappls library dependencies