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:

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:

CocoaPods

Add to your Podfile:

Then run:

Kotlin Multiplatform

For KMP projects targeting both platforms:

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

iOS

ProGuard / R8 (Android)

circle-info

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

Last updated