Creating a new application

Go to Purchasely console with your credentials.

These credentials are provided to you by the Purchasely Team. If you want to have your credentials created, just contact us at hello@purchasely.com

Creating a new App

To create a new app, click on the Add new application in the drop down menu of the top-left corner

If you have 2 different environments (e.g. : staging & production), you should create 2 different Applications in the Purchasely Console and use 2 different API keys

We advise you to start creating a staging application first (i.e. a mobile application plugged to a staging environment) to perform your first tests.

This new application must be configured with a set of parameters among 3 different stages. All these parameters can be modified after the application has been created.

1. Create a new application

The mandatory parameters are :

Name * : the name of the application as it will be display in the Purchasely Console
The default langage * : this will define which language shall be used when the language on a user device is not supported by the application

2. Plug it with .the stores

You can add up to 4 different stores. Each store step by step configuration is explained below, in dedicated sections.

3. Plug it with your backend

In this section, you can plug the Purchasely Cloud Platform with your own backend through a server-to-server integration. This will allow to have your backend notified through a webhook, when a subscription event is received from the stores.

This allows your app to open accesses to the relevant features & contents when a user purchases a specific product or subscription... ... and to close the accesses when the user subscription is expired or the when the user gets refund. Opening / closing accesses and managing entitlements is the responsibility of your own backend.

Fill in the Client webhook URL with the endpoint URL on your own backend where you want to receive the subscription events.

If your Client Webhook is not ready when you make your configuration, we advise you to use the following value: https://httpstat.us/200

This value will simulate a HTTP 200 response code allowing the Purchasely Cloud Platform to consider that the new subscription has been duly acknowledged by the Client Backend.

Every message send by Purchasely in the webhook is signed using a Client shared secret.

Refer to Webhook documentation to know more.

Configuring the Apple App Store parameters

App bundle id

The Bundle ID is used by Purchasely Cloud Platform to validate that receipts are indeed coming from your app

Get the value of the Bundle ID field in App Store Connect App Store Connect > My Apps > [YOUR APP] > General > App Information

The value of the Bundle ID should be reported in the field App Package in the Purchasely Console Purchasely > Mobile Applications > [YOUR APPLICATION] > Edit Mobile Application > iOS configuration

Shared App Secret

The Shared App Secret is used by Purchasely Cloud Platform and required to validate receipts for this specific app

Get the value of the App-Specific Shared Secret field in App Store Connect App Store Connect > My Apps > [YOUR APP] > In-App Purchases > Manage > App-Specific Shared Secret

The value of the App-Specific Shared Secret should be reported in the field Shared App Secret in your Purchasely console

The last field Server-to-server endpoint is not mandatory. It is used to activate the real-time server-to-server notifications coming from the App Store.

Refer to Server-to-server notifications documentation for more information.

Configuring the Google Play Store parameters

Android App Bundle ID

The Bundle ID is used by Purchasely Backend to validate that receipts are indeed coming from your app

Get the value of the Package ID of your App in Googe Play Google Play Console > [YOUR APP] > (i)

The value of the Package ID should be reported in the field App bundle id in your Purchasely console

Acces Key (JSON)

This access key is mandatory to allow Purchasely Cloud Platform to decode Play Store receipts / token

Create a new Service Account

Create a dedicated Service Account under Google Cloud Platform Console https://console.cloud.google.com Google Cloud Platform > IAM & admin > Service Account > Create a new Service Account

Before creating the service account, make sure that the relevant Organisation is selected. The drop down menu in the upper left corner of the screen shall match the Organisation in your Google Play Console

Name your account Purchasely to be able to easily identify it later
Give it the ID purchasely
On the following screen, set the role to "Owner"
On the following screen, create a key by clicking on the + Create a key button
Choose JSON format
Save the file on your computer, you will need to upload it later in your Purchasely Console

Grant API Access to the new Service Account

Grant the access to the Service Account under the Google Play Console Google Play Console > Developer Account > API Access > [PURCHASELY SERVICE ACCOUNT] > Grant authorisation

The Organisation should match the one you chose under the Google Cloud Platform console

Set "no expiration date"
App permissions - Select the application corresponding to the app bundle id
Account permissions - Ensure the following permissions are selected :
- Display applications information
- Display financial data
- Handle orders
- Modify sheets, fares and distribution parameters

Upload the JSON content

Upload the JSON key under your Purchasely console in the field Access key (JSON)

Configuring Huawei AppGallery parameters

Huawei App Package ID

The Package name is used by Purchasely Cloud Platform to validate the authenticity of the receipts.

Open your AppGallery Console
Go to: AppGallery Connect > My Apps > [YOUR APPLICATION]
Get the value of the Package name

The value of the Package name should be reported in the field Huawei App package id in your Purchasely console

App ID

The App ID is used by Purchasely Cloud Platform to validate the authenticity of the receipts.

Same procedure as "App Package Id", with the App ID property which must be put under App id in the Purchasely Console (Purchasely > Mobile Applications > [YOUR APPLICATION] > Huawei configuration)

App secret

The App secret is used by Purchasely Cloud Platform to validate the authenticity of the receipts.

Same procedure as "App Package Id", with the App secret property which must be put under App secret in the Purchasely Console (Purchasely > Mobile Applications > [YOUR APPLICATION] > Huawei configuration)

Public key

The public key is used by Purchasely Cloud Platform to validate the authenticity of the receipts.

Open your AppGallery Console
Go to: AppGallery Connect > My Apps > [YOUR APPLICATION]
In the "All services" menu on top, search for "In-App Purchases" and click on it
Get the Public key property

Fill in this value under "In-App Purchases" public key in the Purchasely Console (Purchasely > Mobile Applications > [YOUR APPLICATION] > Huawei configuration)