Installation

This guide covers how to add Amply SDK to your Android or iOS project.

Requirements

Platform	Minimum Version
Android	API 21 (Android 5.0)
iOS	14.1
Kotlin	1.9+
Xcode	14+

Android Installation

Gradle (Kotlin DSL)

Add the dependency to your app's build.gradle.kts:

dependencies {
    implementation("tools.amply:sdk-android:0.1.7")
}

Gradle (Groovy)

dependencies {
    implementation 'tools.amply:sdk-android:0.1.7'
}

Repository Configuration

If using Maven Central (default), no additional configuration is needed. For snapshot versions, add the snapshot repository:

repositories {
    mavenCentral()
    // For snapshots
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}

iOS Installation

Swift Package Manager (SPM)

1

Add package via Xcode

• In Xcode, go to File → Add Package Dependencies

• Enter the repository URL: https://github.com/amply-tools/amply-sdk-ios

• Select the version and add to your target

2

Add to Package.swift

Alternatively, add the dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/amply-tools/amply-sdk-ios", from: "0.1.7")
]

CocoaPods

Add to your Podfile:

pod 'AmplySDK', '~> 0.1.7'

Then run:

pod install

Kotlin Multiplatform

For KMP projects targeting both platforms:

kotlin {
    sourceSets {
        val commonMain by getting {
            dependencies {
                implementation("tools.amply:sdk-kmp:0.1.7")
            }
        }
    }
}

Obtaining API Keys

To use Amply SDK, you need:

• App ID - Your application bundle identifier (e.g., com.example.myapp)

• Public API Key - Used for client identification

• Secret API Key - Used for request signing

Contact the Amply team or access the dashboard to obtain your credentials.

Verifying Installation

Android

import tools.amply.sdk.Amply
import tools.amply.sdk.config.amplyConfig

// In your Application class
val config = amplyConfig {
    api {
        appId = "your.app.id"
        apiKeyPublic = "your_public_key"
        apiKeySecret = "your_secret_key"
    }
}

val amply = Amply(config, application)
amply.track("test_event")

iOS

import AmplySDK

let config = AmplyConfig(
    appId: "your.app.id",
    apiKeyPublic: "your_public_key",
    apiKeySecret: "your_secret_key",
    defaultConfig: nil
)

let amply = Amply(config: config)
amply.track(event: "test_event")

ProGuard / R8 (Android)

The SDK includes its own ProGuard rules. No additional configuration is needed.