Content of this article
- Preliminary Remarks
- App Store Connect
- Create Connection in the Merchant Backend
1. Preliminary Remarks
To connect the apps (Storekit v2) with the Merchant Backend, the following data is required which you can find in the App Store Connect:
- Bundle ID
- Shared Secret
- Issuer ID
- Key ID
- Einrichten des Webhooks
Name of the app (Bundle ID)
The name of the app is understood to be the unique bundle ID. The bundle ID must match the ID used during app development (within X-Code).
Attention: Please do not use the information from the free text field "Name" in the App Store Connect backend.
App-specific key (Shared Secret)
The app-specific key (Shared Secret) is required to initiate and authenticate a connection between the Apple API and the plenigo API. The Shared Secret is a unique code to call app receipts for auto-renewable subscriptions for the selected app.
If multiple apps are to be used, each app needs its own Shared Secret.
Note: Only the roles Account Owner and Administrator can view and create a Shared Secret. |
2. App Store Connect
Follow the following steps to get the required information from the App Store Connect Backend.
1. Name of the app (Bundle-ID)
- In the main menu item Apps, open the desired app.
- In the navigation bar on the left hand side under General, click on App Information.
- Under General Information, you will find the Bundle ID (structure of the Bundle ID: com.companyname.appname)
2. Shared Secret
The Shared Secret can also be found in the main menu item Apps > desired App > General > App Information.
- In the section App-specific key (Shared Secret), click on the link Manage.
- Create a new Shared Secret or copy the existing one.
3. Issuer ID und Key ID
- Open the main menu item Users and Access Rights.
- Open the Integration tab.
- By default, the menu item App Store Connect API > Team Keys opens.
- Here, you will find the Issuer ID.
- The Key ID can be found in the table in the column Key ID.
4. Setting up the plenigo webhook
The webhook setup can also be found in the main menu item Apps > desired App > General > App Information.
- In the section App Store Server Notifications, click on the link Setup URL.
- Enter the URL of the plenigo webhook in the field Production Server URL.
- Stage System: https://callbacks.plenigo-stage.com/callbacks/v1.0/appStore/{companyId}/appleappstore
- Live System: https://callbacks.plenigo.com/callbacks/v1.0/appStore/{companyId}/appleappstore
The plenigo Company ID can be viewed in the Merchant Backend in the desired client under Settings / Development / JS-SDK. - Version selection: Version 2
3. Create Connection in the Merchant Backend.
The data copied from the App Store Connect can now be stored in the Merchant Backend.
- Open the desired client.
- In the Settings menu item, open Development.
- Open the Mobile Apps menu item.
- In the action bar, click on Add iOS App.
- Add the data from the App Store Connect.