iOS - Adapty SDK installation & configuration

Adapty comprises two crucial SDKs for seamless integration into your mobile app:

• Core AdaptySDK: This is a fundamental, mandatory SDK necessary for the proper functioning of Adapty within your app.
• AdaptyUI SDK: This optional SDK becomes necessary if you use the Adapty Paywall builder: a user-friendly, no-code tool for easily creating cross-platform paywalls. These paywalls are built in a visual constructor right in our dashboard, run entirely natively on the device, and require minimal effort from you to create something that performs well.

Please consult the compatibility table below to choose the correct pair of Adapty SDK and AdaptyUI SDK.

Adapty SDK version	AdaptyUI SDK version
2.7.x, 2.8.x	2.0.x
2.9.x - 2.10.0	2.1.2
2.10.1	2.1.3
2.10.3 and all later 2.10.x versions	2.1.5
2.11.1	2.11.1
2.11.2	2.11.2
2.11.3	2.11.3
3.x	Included as a module within the Adapty SDK. For more information, see iOS - Adapty SDK v. 3.x installation & configuration.

You can install AdaptySDK and AdaptyUI SDK via CocoaPods, or Swift Package Manager.

danger

Go through release checklist before releasing your app

Before releasing your application, make sure to carefully review the Release Checklist thoroughly. This checklist ensures that you've completed all necessary steps and provides criteria for evaluating the success of your integration.

Install SDKs via CocoaPods

1. Add Adapty to your Podfile:

   Podfile

   pod 'Adapty', '~> 2.11.3'
   pod 'AdaptyUI', '~> 2.11.3'

2. Run:

   Shell

   pod install

This creates a .xcworkspace file for your app. Use this file for all future development of your application.

Install SDKs via Swift Package Manager

1. In Xcode go to File -> Add Package Dependency.... Please note the way to add package dependencies can differ in XCode versions. Refer to XCode documentation if necessary.
2. Enter the repository URL https://github.com/adaptyteam/AdaptySDK-iOS.git
3. Choose the version, and click the Add package button. Xcode will add the package dependency to your project, and you can import it.
4. In the Choose Package Products window, click the Add package button once again. The package will appear in the Packages list.
5. Repeat steps 2-3 for AdaptyUI SDK URL: https://github.com/adaptyteam/AdaptyUI-iOS.git.

Configure Adapty SDK

You only need to configure the Adapty SDK once, typically early in your application lifecycle:

Swift

// In your AppDelegate class:

let configurationBuilder =
    Adapty.Configuration
        .Builder(withAPIKey: "PUBLIC_SDK_KEY")
        .with(observerMode: false) // optional
        .with(customerUserId: "YOUR_USER_ID") // optional
        .with(idfaCollectionDisabled: false) // optional
        .with(ipAddressCollectionDisabled: false) // optional

Adapty.activate(with: configurationBuilder) { error in
  // handle the error
}

SwiftUI

import Adapty

@main
struct SampleApp: App {
    init() 
      let configurationBuilder =
        Adapty.Configuration
          .Builder(withAPIKey: "PUBLIC_SDK_KEY")
          .with(observerMode: false) // optional
          .with(customerUserId: "YOUR_USER_ID") // optional
          .with(idfaCollectionDisabled: false) // optional
          .with(ipAddressCollectionDisabled: false) // optional

        Adapty.activate(with: configurationBuilder) { error in
          // handle the error
        }
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Parameters:

Parameter	Presence	Description
PUBLIC_SDK_KEY	required	The key you can find in the Public SDK key field of your app settings in Adapty: App settings-> General tab -> API keys subsection
observerMode	optional	A boolean value controlling Observer mode. Turn it on if you handle purchases and subscription status yourself and use Adapty for sending subscription events and analytics. The default value is false. 🚧 When running in Observer mode, Adapty SDK won't close any transactions, so make sure you're handling it.
customerUserId	optional	An identifier of the user in your system. We send it in subscription and analytical events, to attribute events to the right profile. You can also find customers by customerUserId in the Profiles and Segments menu.
idfaCollectionDisabled	optional	Set to true to disable IDFA collection and sharing. the user IP address sharing. The default value is false. For more details on IDFA collection, refer to the Analytics integration section.
ipAddressCollectionDisabled	optional	Set to true to disable user IP address collection and sharing. The default value is false.

note

• Note, that StoreKit 2 is available since iOS 15.0. Adapty will implement the legacy logic for older versions.
• Make sure you use the Public SDK key for Adapty initialization, the Secret key should be used for server-side API only.
• SDK keys are unique for every app, so if you have multiple apps make sure you choose the right one.

Please keep in mind that for paywalls and products to be displayed in your mobile application, and for analytics to work, you need to display the paywalls and, if you're using paywalls not created with the Paywall Builder, handle the purchase process within your app.

Set up the logging system

Adapty logs errors and other crucial information to provide insight into your app's functionality. There are the following available levels:

Level	Description
error	Only errors will be logged.
warn	Errors and messages from the SDK that do not cause critical errors, but are worth paying attention to will be logged.
info	Errors, warnings, and serious information messages, such as those that log the lifecycle of various modules will be logged.
verbose	Any additional information that may be useful during debugging, such as function calls, API queries, etc. will be logged.

You can set logLevel at any time in the application's lifespan, but we recommend that you do this before configuring Adapty.

Swift

Adapty.logLevel = .verbose

Redirect the logging system messages

If you for some reason need to send messages from Adapty to your system or save them to a file, you can override the default behavior:

Swift

Adapty.setLogHandler { level, message in
    writeToLocalFile("Adapty \(level): \(message)")
}