Track customer events and identify users in Android and Kotlin Multiplatform apps. Explore the integration through a shared Compose UI for Android and iOS.

Integration guide · Compose example · Changelog

This repository contains SDK integration guidance and a Compose Multiplatform reference app. The app consumes the published io.binoban.sdk:sdk dependency from Maven Central. It does not contain the SDK library implementation.

The example app's OS requirements are higher than the SDK's Android minimum. Use the checked-in Gradle wrapper and an Android Studio version compatible with Android Gradle Plugin 8.9.3.

Ensure mavenCentral() is available in your dependency repositories.

For an Android app:

dependencies {
    implementation("io.binoban.sdk:sdk-android:1.3.0")
}

For a Kotlin Multiplatform app:

commonMain.dependencies {
    implementation("io.binoban.sdk:sdk:1.3.0")
}

The included reference app already declares its dependency in gradle/libs.versions.toml.

Request your API key, source identifier, and API host from tech@binoban.io. For Android, initialize the client in your Application class and pass the application instance:

import android.app.Application
import io.binoban.sdk.core.Binoban

class MyApplication : Application() {
    lateinit var binoban: Binoban

    override fun onCreate() {
        super.onCreate()
        binoban = Binoban("YOUR_API_KEY", "YOUR_SOURCE_IDENTIFIER") {
            application = this@MyApplication
            apiHost = "YOUR_API_HOST"
            trackApplicationLifecycleEvents = true
        }
    }
}

Register your application class in your Android manifest. The iOS example creates its client in MainViewController.kt.

apiHost is required. An invalid configuration produces a disabled client and reports the reason through Configuration.errorHandler.

import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.put

binoban.track("Order Completed", buildJsonObject {
    put("total", 42.0)
})

binoban.identify("user-123", buildJsonObject {
    put("plan", "enterprise")
})

binoban.flush()

1. Clone this repository and open it in Android Studio.
2. Replace the credential and host placeholders in both platform entry points:
   • Android MainApplication.kt
   • iOS MainViewController.kt
3. Run the Android composeApp configuration, or install the debug build on a connected emulator or device:

./gradlew :composeApp:installDebug

For iOS, open iosApp/iosApp.xcodeproj in Xcode, select your signing team and destination, then run the app.

Run Track, then Flush. Check the SDK logs and confirm that your deployment accepts the event using the Developer Quick Start. The JSON preview shows call inputs; it is not a delivery receipt.

If the client is disabled, check the credentials and apiHost first. If the app cannot resolve its SDK dependency, check access to Maven Central and the version in the Gradle catalog.

The prebuilt Swift Package and CocoaPods XCFramework includes PrivacyInfo.xcprivacy. A Kotlin Multiplatform dependency does not automatically carry that bundled manifest into an iOS framework you build yourself.

For a custom KMP iOS framework, include an app privacy manifest covering the SDK's documented collection of device IDs, user IDs, and product-interaction events, plus the UserDefaults (CA92.1) and file-timestamp (C617.1) Required-Reason APIs. Declare any additional custom traits your app sends. See the native SDK guide and iOS SDK guidance.

• Native Android with Jetpack Compose
• Native iOS with SwiftUI
• React Native for Android and iOS

• Integration guide
• Developer Quick Start
• Report a bug or request a feature
• Contribution guide
• Deployment access, credentials, and host configuration: tech@binoban.io.

Report vulnerabilities privately through the security policy. Use placeholders when sharing configuration or reproduction steps.

Apache-2.0. See LICENSE.

Binoban provides enterprise Customer Data Experience Platform (CDXP) infrastructure that connects customer data with prediction, decisioning, and activation across customer engagement, retail media, and advertising.

Seer. Protector. Builder. See the signal. Recognize risks and opportunities. Build what comes next.

Binoban · Developer documentation · GitHub organization

Future In Your Hands