This article will guide you through setting up an integration with the App Store to send purchase event data from your payment gateway to your analytics system.
Start by accessing the "Project Overview" in your Onboarding.Online control panel. In the App Store section, click on 'Create'.
You will need to complete several fields to set up the correct event transmission:
Setting up the Server URL in App Store Connect.
It is a crucial step for integrating server notifications that track real-time events, such as transactions from your app. Here’s how to correctly enter the URL:
Copy the URL from the form
Go to App Store Connect: Open App Store Connect in your web browser.
Select Your App: From the list of apps available, select the app for which you want to configure server notifications.
Navigate to App Information: In the sidebar under the "General" section, proceed to "App Information".
Locate App Store Server Notifications: Scroll to find the "App Store Server Notifications" section.
Paste the URL:
Paste the generated Server Notifications URL into the "Production Server URL" field.
Also, paste the same URL into the "Sandbox Server URL" field if you are also testing your app in a development environment.
Bundle ID
A Bundle ID or bundle identifier uniquely identifies an application in Apple's ecosystem. This means that no two applications can have the same bundle identifier.
1.To find Bundle ID, open your app page in App Store Connect first.
2. Go to the App Information page in section General, and find Bundle ID in the left bottom part of the screen.
3. Navigate to your Onboarding.Online Paywall pop-up and insert the copy-pasted Bundle ID from AppStore into the relevant field Bundle ID.
In-app purchase Issuer ID / Key ID
1. You can find the Issuer ID and Key ID in App Store Connect under "Users and Access"
2. Next, choose the tab Integrations → In-App Purchase.
3. Copy-paste the required IDs and insert them into the relevant fields in Onboarding.Online app pop-up.
In-app purchase Private Key (.p8 file)
In-app purchase keys are created for your entire account and can be applied to multiple apps. You can have up to 10 active subscription keys at any time (according to App Store policy). The keys do not expire but can be revoked.
1. Open the "Users and Access" tab in the App Store Connect.
2. In the sidebar under Keys, click the Integrations tab and opt for In-App Purchase.
⚠️ If you already have an Active In-App Purchase key generated, you may download and attach to Onboarding.Online the existing file. Otherwise, you will click the Add (+) icon. |
3. The next step is to enter a name for the key in the pop-up and then click Generate to receive the In-app Purchase Key.
4. Download the generated file and attach it to the In-app purchase Private Key (.p8 file) field in the Onboarding.Online screen.
App Store Shared Secret
A 32-character hexadecimal string generated in App Store Connect. You can generate a shared secret that will be a single code for all your apps or a specific one for individual apps.
☑️ For Onboarding.Online you will require an app-specific shared secret. |
From Apps, first select your app. In the sidebar under General, proceed to App Information. After that, in the App-Specific Shared Secret section, click Manage.
2. You can generate a shared secret by clicking the Generate button.
⚠️ Clicking Regenerate will automatically generate a new shared secret, and any previously generated shared secret for this app will be invalidated. If re-generated, make sure to use the new value for the app. |
Create your App Store Integration
Once you've filled in all the required fields and clicked on "Create" in the form
Important - Delay in Applying Server URL:
There is a time lag on the Apple Store’s end when applying the Server URL, which can last about 10-15 minutes. Thus, you might encounter an error when clicking 'Create' during this period.
Please do not close the form if you see an error initially. Instead, wait about 15 minutes and then click 'Create' again. This delay allows the App Store's systems to process and recognize the new server URL.
Next steps:
Connect analysis where purchase events have to be sent:
Currently, we support those 2 Analytics, but we are working to add more