Vendor API flow overview

Before you start integrating your app with Setapp via Vendor API, you might want to know what the entire flow looks like. We hope this article will bring more clarity.

📘

Check out our detailed diagram on iOS flow integrated via Vendor API. If you have any questions, don't hesitate to contact your Developer Support Representative.

1. The user goes to the app page on Setapp desktop and clicks "Get iOS App" for iOS apps or "Get Web App" for the web apps.

2. The user scans the first QR code with the native phone camera.

3. The user is redirected to App Store and must install the app.

4. The user goes back to Setapp and scans the second QR code. Your app is opened by app.url.scheme://ios.setapp.com/unlock.

5. The user sees the "Sign in with Setapp" button (the label might differ) and clicks it.

6. Your app redirects the user to Setapp, where they must enter their Setapp credentials.

Note: Here, we check whether a user has confirmed their email. If not, we suggest resending the confirmation link and waiting until the user confirms the email.

7. User grants access to the app by clicking the Authorize button or declines access by clicking the Cancel button.
8. Setapp redirects the user to your app again, attaching an auth code to the app Redirect URL.
9. Your app exchanges the auth code with access & refresh tokens. Then your app uses the token to request the user's email.
10. Your app creates a user account and connects it with Setapp.
11. Your app validates the user's subscription via the backend. See Access client's app API to implement this step.
12. The user is signed in, and your app notifies about successful signing in. The user can now use your app.

13. Your app sends the usage report. See Report app usage to implement this step.