Install the SDK

Overview

The Encore Flutter SDK lets your app present premium brand offers, real perks funded by brands, at the moments you choose. The plugin wraps the native iOS (Encore.xcframework) and Android (com.encorekit:encore AAR) SDKs: all offer UI, billing, analytics, and entitlement logic runs natively, and the Flutter layer is a thin bridge via platform channels. You’ll add the Dart package, then configure platform-specific dependencies for iOS and Android.

Prerequisites

The plugin requires Dart 3.0 or later and Flutter 3.10 or later. Before installing the SDK, obtain your API Key (starts with pk_...) from the Encore Dashboard.

Don’t have an API key? Visit dashboard.encorekit.com to create an account, add your app, and receive your API key automatically.

Step 1: Add the Dart Package

Add the Encore Flutter SDK to your pubspec.yaml:

dependencies:
  encore_flutter: ^2.0.0

Then fetch dependencies:

flutter pub get

This documentation describes the 2.x surface. The plugin pins the native SDKs it was built against (EncoreKit 2.x on iOS, com.encorekit:encore 2.x on Android), so a plugin major tracks a native major.

Migrating an existing 1.x integration? 2.0 is a breaking release. Updating to 2.x walks the migration step by step.

Step 2: iOS Setup

The EncoreKit CocoaPod is automatically included as a transitive dependency of the Flutter plugin, so no manual pod configuration is needed.

Set Deployment Target

In your ios/Podfile, ensure the platform is set to iOS 15.0 or higher:

platform :ios, '15.0'

Install Pods

cd ios && pod install && cd ..

Step 3: Android Setup

The com.encorekit:encore AAR is automatically included as a transitive dependency of the Flutter plugin, so no manual Gradle configuration is needed.

Set Min SDK Version

In your android/app/build.gradle.kts, ensure minSdk is set to 26 or higher:

android {
    defaultConfig {
        minSdk = 26
    }
}

Step 4: Verify Installation

After completing the platform setup, verify the SDK is available:

import 'package:encore_flutter/encore_flutter.dart';

Build and run your app to confirm everything compiles:

flutter run

Installation complete!

Next Steps

Now that the SDK is installed, continue with the integration:

Configure the SDK: set up your API key and initialize Encore
Identify Users: associate user identity for offer tracking

Already Installed?

If you’ve already installed the SDK and need to update to a newer version, see Updating the SDK.

iOS

Android

Web

Bridges

Install the SDK

Overview

Prerequisites

Step 1: Add the Dart Package

Step 2: iOS Setup

Set Deployment Target

Install Pods

Step 3: Android Setup

Set Min SDK Version

Step 4: Verify Installation

Next Steps

Already Installed?

​Overview

​Prerequisites

​Step 1: Add the Dart Package

​Step 2: iOS Setup

​Set Deployment Target

​Install Pods

​Step 3: Android Setup

​Set Min SDK Version

​Step 4: Verify Installation

​Next Steps

​Already Installed?

Overview

Prerequisites

Step 1: Add the Dart Package

Step 2: iOS Setup

Set Deployment Target

Install Pods

Step 3: Android Setup

Set Min SDK Version

Step 4: Verify Installation

Next Steps

Already Installed?