Installation

Add the OnsideKit framework to your iOS project with Swift Package Manager, CocoaPods, or a manual framework install.

You can integrate OnsideKit using Swift Package Manager, CocoaPods, or by adding the framework manually.

Requirements

• iOS 16.0 or later as your deployment target

• Xcode 26 or later

Choose a product

OnsideKit is distributed as two separate products. Pick the one that fits your app:

Product	When to use it
OnsideKit	The full SDK, including Apple Pay. Use this unless you have a specific reason not to.
OnsideKitLite	The same SDK without the PassKit dependency (no Apple Pay), for apps that cannot include PassKit.

Both products are identical apart from Apple Pay support. See OnsideKit vs OnsideKitLite for the details. Everywhere below, swap OnsideKit for OnsideKitLite if you need the PassKit-free build.

Framework installation

Swift Package Manager

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

1. In Xcode, select your project in the Project Navigator, then open the Package Dependencies tab for the project.

1. Click the + button to add a new package.

2. In the search field, paste the SDK's repository URL:

   https://github.com/onside-io/OnsideKit-iOS

3. For the Dependency Rule, we recommend "Up to Next Major Version" to receive updates and bug fixes without breaking changes. Click Add Package.

1. Choose the product to add to your app's target — OnsideKit (with Apple Pay) or OnsideKitLite — and click Add Package.

The framework now appears in the Project Navigator and is linked to your target.

CocoaPods

Manual

You can now import OnsideKit (or import OnsideKitLite) in your source files.

Next step

Before calling any OnsideKit API you must initialize the SDK and configure your URL scheme. Continue with Initializing the SDK.