Skip to main content

​
Overview

The Encore Flutter SDK is a plugin that wraps the native iOS (Encore.xcframework) and Android (com.encorekit:encore AAR) SDKs. All offer UI, billing, analytics, and entitlement logic runs natively — 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

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: ^1.0.0
Then fetch dependencies: 
flutter pub get

​
Step 2: iOS Setup

The EncoreKit CocoaPod is automatically included as a transitive dependency of the Flutter plugin — 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 — 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: