Skip to main content

iOS - Adapty SDK installation & configuration

Adapty SDK includes two key modules for seamless integration into your mobile app:

  • Core Adapty: This essential SDK is required for Adapty to function properly in your app.
  • AdaptyUI: This optional module is needed if you use the Adapty Paywall Builder, a user-friendly, no-code tool for easily creating cross-platform paywalls. These paywalls are built with a visual constructor right in our dashboard, run natively on the device, and require minimal effort to create high-performing designs.
info

If you’re using an older version of Adapty SDK and want to upgrade to version 3.x, we recommend following our Migration guide to Adapty SDK v.3.x or later.

You can install Adapty SDK via CocoaPods or Swift Package Manager.

danger

Review the release checklist before launching your app

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

Install Adapty SDK via Swift Package Manager​

In Xcode, go to File -> Add Package Dependency.... Note that the steps to add package dependencies may vary between Xcode versions, so refer to Xcode documentation if needed.

  1. Enter the repository URL: https://github.com/adaptyteam/AdaptySDK-iOS.git.
  2. Select the version and click Add Package.
  3. Choose the modules you need:
    1. Adapty is the mandatory module.
    2. AdaptyUI is optional and needed if you plan to use the Adapty Paywall Builder.
  4. Xcode will add the package dependency to your project. To import it, in the Choose Package Products window, click the Add package button once again. The package will then appear in the Packages list.

Install SDKs via CocoaPods​

  1. Add Adapty to your Podfile. Choose the modules you need:

    1. Adapty is the mandatory module.
    2. AdaptyUI is an optional module you need if you plan to use the Adapty Paywall Builder.
    Podfile
    pod 'Adapty', '~> 3.2.0'
    pod 'AdaptyUI', '~> 3.2.0' # optional module needed only for Paywall Builder

  2. Run:

    Shell
    pod install

This will create a .xcworkspace file for your app. Use this file for all future development.

Configure Adapty SDK​

You only need to configure the Adapty SDK once, typically early in your app's lifecycle.

Activate Adapty module of Adapty SDK​

// In your AppDelegate class:
import Adapty

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

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

Parameters:

ParameterPresenceDescription
PUBLIC_SDK_KEYrequiredThe key you can find in the Public SDK key field of your app settings in Adapty: App settings-> General tab -> API keys subsection
observerModeoptional

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.

customerUserIdoptionalAn 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.
idfaCollectionDisabledoptional

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.

ipAddressCollectionDisabledoptional

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.

Remember that for paywalls and products to display in your app, and for analytics to function, you need to display the paywalls and, if you're not using the Paywall Builder, handle the purchase process within your app.

Activate AdaptyUI module of Adapty SDK​

You need to configure the AdaptyUI module only if you plan to use Paywall Builder and have installed AdaptyUI module:

Swift
import AdaptyUI // Only if you are going to use AdaptyUI

// After calling Adapty.activate()
let adaptyUIConfiguration = AdaptyUI.Configuration(
    mediaCacheConfiguration: .init(
        memoryStorageTotalCostLimit: 100 * 1024 * 1024,
        memoryStorageCountLimit: .max,
        diskStorageSizeLimit: 100 * 1024 * 1024
    )
)

try await AdaptyUI.activate(
    configuration: adaptyUIConfiguration
)

Please note that AdaptyUI configuration is optional, you can activate AdaptyUI module without its config. However, if you use the config, all parameters are required in it.

Parameters:

ParameterPresenceDescription
memoryStorageTotalCostLimitrequiredTotal cost limit of the storage in bytes.
memoryStorageCountLimitrequiredThe item count limit of the memory storage.
diskStorageSizeLimitrequiredThe file size limit on disk of the storage in bytes. 0 means no limit.

Redirect the logging system messages​

If you need to send Adapty's log messages to your system or save them to a file, you can add the desired behavior:

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