Configure the SDK

Overview

As soon as your app launches, you need to configure the SDK with your API Key. Retrieve your publishable Live key yourself from the Dashboard under Settings → Project API Keys (use the Test key for staging and local development).

Initialize Encore in your app

Call configure() in your Application.onCreate() so the SDK is ready before any Activity starts.

// YourApplication.kt

import android.app.Application
import com.encorekit.encore.Encore

class YourApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        // Configure Encore with your API key
        Encore.shared.configure(this, apiKey = "pk_your_api_key_here")
    }
}

Make sure your custom Application class is registered in AndroidManifest.xml:

<application
    android:name=".YourApplication"
    ... >

This configures a shared instance of Encore, the primary class for interacting with the SDK’s API. Make sure to replace pk_your_api_key_here with your public API key.

Can’t find your API key? Open your project’s Settings → Project API Keys in the Encore Dashboard and copy the Live key (or Test for non-production builds).

Register a purchase controller

If your app sells a subscription product through Encore offers, register an EncorePurchaseController at configure time. The SDK has no built-in billing: when a user accepts an offer that requires a purchase, the SDK calls your controller, which performs the purchase through your billing code and reports back. Add the controller to the call you already have. configure() runs once per process: a second call logs a warning and is ignored, so a controller passed to it never registers.

// The same single call from the step above, now with your controller
Encore.shared.configure(
    context = this,
    apiKey = "pk_your_api_key_here",
    purchaseController = AppPurchases(billing),
)

See Presenting Offers for where the controller runs, and EncorePurchaseController for RevenueCat, Play Billing, and custom implementations. Apps that use Encore offers without a subscription product can skip the controller: with no product configured, no purchase is ever attempted.

Next Steps

Now that Encore is configured, you’re ready to:

User Management - Identify users for entitlement tracking
Present Offers - Show promotional offers and read the result

iOS

Android

Web

Bridges

Configure the SDK

Overview

Initialize Encore in your app

Register a purchase controller

Next Steps

​Overview

​Initialize Encore in your app

​Register a purchase controller

​Next Steps

Overview

Initialize Encore in your app

Register a purchase controller

Next Steps