Kotlin SDK

Installation Prerequisites

OS	MinSDK	Prerequisite
Android	24	GitHub user & Personal Access Token

Generate a personal access token for GitHub

In you GitHub account:

If you don't have a user, register to Github.
Go to Settings › Developer Settings › Personal Access Tokens › Generate new token
Make sure you select the following scopes: (“ write:packages”, “read:packages") and Generate a token
Make sure to copy your new personal access token. You won't be able to see it again! Your only option if it's lost is to generate a new key.

Installing the Kotlin SDK

Add a dependency

Include the following dependency in your project, with the specific SDK version as follows (see examples):

Kotlin DSL: build.gradle.kts
Groovy:build.gradle

dependencies {
    implementation("com.dynamicyield:dy-sdk:<VERSION>")
}

dependencies {
    implementation 'com.dynamicyield:dy-sdk:<VERSION>'
}

Add authentication

Because the package is hosted on GitHub Packages, authentication is required. Ensure that your gradle.properties contains:

github.username=GITHUB_USERNAME
github.token=GITHUB_PERSONAL_ACCESS_TOKEN

github.username=GITHUB_USERNAME
github.token=GITHUB_PERSONAL_ACCESS_TOKEN

And update your repositories block in build.gradle.kts or settings.gradle.kts

import java.util.Properties

repositories {
        maven {
            val properties = Properties()
            file("gradle.properties").inputStream().use {
                properties.load(it)
            }
            url = uri("https://maven.pkg.github.com/DynamicYield/DY-Android-SDK")
            credentials {
                username =
                    System.getenv("GITHUB_USERNAME") ?: properties.getProperty("github.username")
                password = System.getenv("GITHUB_TOKEN") ?: properties.getProperty("github.token")
            }
        }
}

repositories { 
    google() 
    mavenCentral() 
    maven { 
        def properties = new Properties() 
        file("gradle.properties").withInputStream { properties.load(it) } 
 
        url = uri("https://maven.pkg.github.com/DynamicYield/DY-Android-SDK") 
        credentials { 
            username = System.getenv("GITHUB_USERNAME") ?: properties.getProperty("github.username") 
            password = System.getenv("GITHUB_TOKEN") ?: properties.getProperty("github.token") 
        } 
    } 
}

Set up app permissions for network access (Android)

Because our SDK uses Experience APIs and makes network calls, it's mandatory to declare the necessary permissions in the AndroidManifest.xml file. This ensures that the app has the appropriate access to the internet for seamless API interactions.

To add network access, add the following permissions to your AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET" />