Getting Started (v5)

How to integrate the Apps Panel Android SDK in your apps

The Apps Panel Android SDK is made to work with the Apps Panel Back Office. It provides a set of tools making your development easier and permitting to access all the features developed by Apps Panel.

The following information explain how to get started by implementing the SDK in your app.

Add the SDK

First, to use the Apps Panel SDK, your application min SDK version must be set to API 19 minimum.

JSON

defaultConfig {
        minSdkVersion 25
				...
}

In order to find the Apps Panel SDK dependency, you need to add the maven repository in the build.gradle file of the project.

build.gradle

allprojects {
    repositories {
        //...
        maven {
            url 'https://repository.appspanel.com/repository/apnl-public-android-sdk/'
            credentials {
                username 'guest'
                password 'CNONt0CkRzgqLpaEN92p'
            }
        }
    }
}

The second step consist in adding the dependency in the build.gradle of your application.

build.gradle

dependencies {
  //...
  implementation 'com.appspanel.android:sdk:5.3.2'
}

Configuration

In your Application class ou can configure the SDK by two way :

First way you have to pass your configuration at the installmethod. Call it by overriding protected void attachBaseContext(Context base) in your Application class as following :

Kotlin

class MainApplication : Application() {
  
    var appsPanelConfiguration = APLocalConfiguration(
         "AppName",
         "AppKey",
         "PrivateKey")

    override fun attachBaseContext(base: Context) {
        super.attachBaseContext(base)
        APSDK.install(this@MainApplication, appsPanelConfiguration, this)
    }
  
}

A second way consist in extending your Application class by APApplication as below :

Kotlin

class MyApplication : APApplication() {
  
  override fun getAppsPanelConfiguration(): APLocalConfiguration {
        return APLocalConfiguration(
            "AppName",
            "AppKey",
            "PrivateKey"
        )
    }
  
}

As parameter of APLocalConfiguration you must provide these elements:

• AppName : the name of your app on the Apps Panel Back Office
• AppKey : the key corresponding to your app on the Apps Panel Back Office
• PrivateKey : the private key to secure your app

Best practice

A proper way to initialize the SDK is to use gradle parameters to manage several environments.
In your build.gradle file add the third attributes as below :

build.gradle

buildTypes {
    debug {
        //...
        //SDK conf
        buildConfigField "String", "AP_SDK_NAME", "\"my-project-dev\""
        buildConfigField "String", "AP_SDK_KEY", "\"abcdefghijklmnopqr\""
        buildConfigField "String", "AP_SDK_PRIVATE", "\"123456789ABCDE\""
    }
    //...
}

And replace the Apps Panel SDK parameters :

Kotlin

var appsPanelConfiguration = APLocalConfiguration(
            BuildConfig.AP_SDK_NAME,
            BuildConfig.AP_SDK_KEY,
            BuildConfig.AP_SDK_PRIVATE)

Custom SDK and API base URL

According to project specifications you may need to custom your SDK base url or API base url. In this case you can spefcify base url as param of your local configuration like below :

Kotlin

var appsPanelConfiguration = APLocalConfiguration(
  appName = BuildConfig.APSDK_ENV,
  appKey = BuildConfig.APSDK_KEY,
  appSecret = BuildConfig.APSDK_PRIVATE,
  baseURL = "https://api-domain.fr",
  sdkBaseURL = "https://sdk-domain.fr",
)

or specify it later like below :

Kotlin

localConf.baseURL = "https://api-domain.fr";
//or/and
localConf.sdkBaseURL = "https://sdk-domain.fr";

Custom SDK Headers

As of 5.4 you can also add custom headers to be added in each request :

Kotlin

APLocalConfiguration(
  appName = BuildConfig.APSDK_ENV,
  appKey = BuildConfig.APSDK_ENV,
  appSecret = BuildConfig.APSDK_PRIVATE,
  customSdkHeaders = hashMapOf(
    "header" to "value",
  ),
)

or later as well

Kotlin

localConf.customSdkHeaders = hashMapOf()

(note that you probably want to add your headers as soon as possible so that all requests use them, so with the first option)

That's all folks

Congratulations, the SDK is now integrated, now you should be able to compile your application 🙌