Install the SDK - Encore SDK

Overview

The Encore SDK is distributed as a public Swift Package. No access token or authentication is required — add it straight from GitHub via Swift Package Manager. The repository URL is:

https://github.com/EncoreKit/ios-sdk

Requirements

Requirement	Minimum
iOS deployment target	iOS 15.0+
Xcode	15.0+ (Swift 5.9+)

The SDK installs and runs on iOS 15+. The offer sheet UI is built with SwiftUI sheets and renders on iOS 17+. On iOS 15–16, calls to placement(_:).show() resolve immediately with NotGrantedReason.unsupportedOS instead of presenting UI, so your onPassthrough handler still runs and the user is never blocked.

Install via Swift Package Manager

Swift Package Manager is Apple’s official dependency manager, integrated into Xcode.

Option A — Add in Xcode

Open Add Package Dependencies

In Xcode, select File ▸ Add Package Dependencies…

Paste the repository URL

Paste the public repository URL into the search field:

https://github.com/EncoreKit/ios-sdk

Press Return — the package resolves automatically.

Set the dependency rule

Set Dependency Rule to Up to Next Major Version with a lower bound of 1.0.0, then click Add Package.

Add to your target

Ensure the Encore library is added to your app’s target, then click Add Package.

Option B — `Package.swift`

If you manage dependencies in a Package.swift manifest, add Encore to your dependencies and to your target:

dependencies: [
    .package(url: "https://github.com/EncoreKit/ios-sdk", from: "1.0.0"),
],
targets: [
    .target(
        name: "YourApp",
        dependencies: [
            .product(name: "Encore", package: "ios-sdk"),
        ]
    ),
]

Verify Installation

You should now be able to import the SDK:

import Encore

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 - Learn how to identify users for offer tracking

For advanced features and complete API documentation, see the SDK Reference.

Already Installed?

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

​Overview

​Requirements

​Install via Swift Package Manager

​Option A — Add in Xcode

​Option B — Package.swift

​Verify Installation

​Next Steps

​Already Installed?

Overview

Requirements

Install via Swift Package Manager

Option A — Add in Xcode

Option B — `Package.swift`

Verify Installation

Next Steps

Already Installed?