This app demonstrates how to use Superwall's Paywall SDK with UIKit. We've written a mini tutorial below to help you understand what's going on in the app.
Usually, to integrate the SDK into your app, you first need to have configured and enabled a paywall using the Superwall Dashboard. However, with this example app, we have already done that for you and provided a sample API key to get you up and running. When you integrate the SDK into your own app, you'll need to use your own API key for your own Superwall account. To do that, sign up for a free account on Superwall.
| Feature | Sample Project Location |
|---|---|
| 🕹 Configuring the Paywall SDK | Services/PaywallService.swift |
| 💰 Presenting a paywall | PresentPaywallViewController.swift |
| 👉 Explicitly Triggering a paywall | ExplicitlyTriggerPaywallViewController.swift |
| 👉 Implicitly Triggering a paywall | ImplicitlyTriggerPaywallViewController.swift |
| 👥 Identifying the user | Services/PaywallService.swift |
This example app uses:
- UIKit
- Xcode 13
- iOS 15
- Swift 5
Clone or download the Paywall SDK from the project home page. Then, open SuperwallUIKitExample.xcodeproj in Xcode and take a look at the code inside the SuperwallUIKitExample folder.
Inside the Services folder, you'll see some helper classes. PaywallService.swift handles the setup and delegate methods of the SDK, and StoreKitService.swift handles the purchasing of in-app subscriptions.
Products.storekit is a StoreKit configuration file that is used to mimic the setup of real products on App Store Connect. This is so you can make test purchases within the sample app without having to set up App Store Connect. In a production app, you will need real products configured in App Store Connect but you can also use a StoreKit configuration file for testing purposes if you wish.
You'll see Main.storyboard specifies the the layout of the app and other swift files handle the presentation of Paywalls.
Build and run the app and you'll see the welcome screen:
The Paywall SDK is configured on app launch, setting an apiKey and delegate.
The SDK sends back events received from the paywall via the delegate methods in PaywallService.swift. You use these methods to make and restore purchases, react to analytical events, as well as tell the SDK whether the user has an active subscription.
On the welcome screen, enter your name in the text field and tap Continue. This saves to the Paywall user attributes using Paywall.setUserAttributes(_:). You don't need to set user attributes, but it can be useful if you want to recall information about the user on your paywall.
You'll see an overview screen:
Paywalls are created and enabled in the Superwall Dashboard and are shown to users who don't have an active subscription. To show a paywall, you have three options: presenting, explicitly triggering, or implicitly triggering.
A paywall is presented by calling Paywall.present(onPresent:onDismiss:onFail:) in PresentPaywallViewController.swift.
The paywall assigned to the user is determined by the settings in the Superwall Dashboard. Once a user is assigned a paywall, they will continue to see the same paywall, even when the paywall is turned off, unless you reassign them to a new one.
Tap Presenting a Paywall. You'll see some explanatory text and a button that presents a paywall to the user:
Then, tap Present Paywall and have a look around. You'll notice analytical delegate methods printing in the console and your name displayed in the paywall:
Triggers enable you to retroactively decide where or when to show a specific paywall in your app. By calling Paywall.trigger(event:onSkip:onPresent:onDismiss:), you explicitly trigger a paywall in response to an analytical event. This event is tied to a trigger that's set up on the Superwall dashboard. In this app, we have tied an active trigger on the dashboard to the event "MyEvent".
Head back to the overview screen, and tap on Explicitly Triggering a Paywall. You'll see some explanatory text and a button that triggers the paywall:
Tap the Trigger Paywall button and you'll see the same paywall as before come up. If the trigger in the dashboard is disabled, this trigger would stop working.
If you don't need completion handlers for triggering a paywall, you can use track(_:_:) to track an event which can be tied to an active trigger in the Superwall Dashboard.
Head back to the overview screen, and tap on Implicitly Triggering a Paywall. You'll see some explanatory text, and two buttons that increment and reset a counter:
Tap on increment 3 times. When the counter reaches 3, it will track an event, which will implicitly trigger a paywall.
Tap the Continue button in the paywall and "purchase" a subscription. When the paywall dismisses, try triggering or presenting a paywall. You'll notice the buttons no longer show the paywall. The paywalls are only presented to users who haven't got an active subscription. To cancel the active subscription for an app that's using a storekit configuration file for testing, delete and reinstall the app.
For an in-depth explanation of how to use the Paywall SDK, you can view our iOS SDK documentation. If you'd like to view it in Xcode, select Product ▸ Build Documentation.
For general docs that include how to use the Superwall Dashboard, visit docs.superwall.com.