This article, intended mainly for developers, explains how to integrate SALESmanago with your Android and/or iOS accounts and your mobile application.
Contents
- Getting started
- Integrating SALESmanago with mobile operating systems
- Integrating SALESmanago with your mobile app
1. Getting started
Setting up the Mobile Push channel on the SALESmanago platform consists of two major steps:
- Integrating your SALESmanago account with at least one of the following mobile operating systems:
- Android (minimum version: 5.0 Lollipop)—Requires the uploading of an FCM Service Account Key.
- iOS (minimum version: 15+)—Requires the uploading of an APNs certificate.
- Integrating SALESmanago with your mobile app—by adding an API key generated in SALESmanago to the application’s code.
Note that you can integrate only one mobile application per SALESmanago account. This mobile application can come in many versions or instances, depending on the system or purpose. For example, if your mobile app has two versions—one for Android and one for iOS—you can integrate both versions as one app.
If you integrate another mobile app (for example, for another brand), the data from the two apps will be combined together and you will be unable to monitor user and engagement statistics separately for these two apps.
Read on for detailed instructions.
2. Integrating SALESmanago with mobile operating systems
Start by going to Menu → Channels → Mobile Push → Settings → Sending settings. Click Integrate your mobile app. A new window will appear.
First, enter the name of your mobile application [1]—this is an internal name that will not be visible to your app users.
Next, click Add [2].
At this stage, select the type of credentials you want to provide:
- FCM (Android)
- APNs (iOS)
The configuration process looks slightly different depending on your choice.
Android
[1] Service Account Key name—Enter the name for this Android integration. The name should allow you to easily identify this FCM key in the list.
[2] Service Account Key file—Upload the JSON file containing the Service Account Key.
To obtain this file, log in to your Firebase account. Select the project you want to integrate with SALESmanago. Click the gear icon next to Project Overview and select Project settings from the menu.
In Project settings, navigate to the Service accounts tab.
Click Generate new private key. A confirmation pop-up will appear. When you click Generate again, the JSON file with your FCM key will be downloaded to your computer.
[3] Test connection [RECOMMENDED]—Click this button to verify the uploaded file and ensure that the connection between SALESmanago and your FCM account will function correctly.
If the message returned is “Connection successfully established”, click Integrate [4].
iOS
[1] Certificate name—Enter the name for this iOS integration. The name should allow you to easily identify this APNs certificate in the list.
[2] Certificate file—Upload the P8 file containing the APNs certificate.
To obtain an APNs certificate, log in to your Apple Developer account. Navigate to the Account tab and select Keys.
Create a new key or select an existing one from the list. When configuring the key, ensure that the option: Apple Push Notifications service (APNs) is enabled.
Download the key. Remember that this action can be performed only once.
On the download page, you can also see the key’s ID (indicated with an arrow in the screenshot above).
Finally, upload the downloaded file in SALESmanago.
[3] Key ID—Provide the ID of the iOS key you want to use for this integration. You can find it on the certificate download screen (see the screenshot above) or by selecting a key from the list and viewing its details.
[4] Team ID and [5] Bundle ID—To obtain these two details, within the Account tab, navigate to Identifiers. Select an identifier from the list or create a new one. When configuring the identifier, ensure that the Push Notifications capability is enabled:
You will find the Team ID (“App ID Prefix”) and the Bundle ID in the identifier’s details.
[6] Test connection [RECOMMENDED]—After uploading the file and providing the required details, click this button to verify the connection between SALESmanago and your APNs account.
NOTE: The following fields: Certificate file, Key ID, and Team ID are verified immediately. The value of the Bundle ID field will be verified during the first attempt at sending a notification.
If the message returned is “Connection successfully established”, click Integrate (or Add) [7].
All added FCM key and APNs certificates can be seen in Menu → Mobile Push → Settings → Application settings, under the Certificates tab.
The Certificates tab is also where you can add further keys and certificates, for example, for testing purposes. You can add up to 5 FCM keys and up to 5 APNs certificates.
3. Integrating SALESmanago with your mobile app
After adding at least one FCM key or APNs certificate, you can proceed to integrating your SALESmanago account with your mobile app.
In Menu → Mobile Push → Settings → Application settings, navigate to the API keys tab and click Create new API key.
Define the settings of your new API key.
[1] API key name—Enter the name for your new API key. The name should allow you to easily identify this key in the list.
[2] Contact owner—Select the SALESmanago user who will be the default main owner of Contacts obtained through your mobile app and transferred to SALESmanago using this specific API key.
[3] Validity period—Decide how long the API key will remain valid after its creation.
IMPORTANT: Carefully monitor the validity of your API keys. The moment an API key expires, the connection between SALESmanago and your application will stop functioning and data will stop being transferred.
An expired API key cannot have its validity period extended—it needs to be replaced with a new key.
After creating an API key, install the SALESmanago SDK. Click the links below to obtain detailed instructions for each system.
- Android >>
IMPORTANT: Remember that the Firebase google-services.json file must be placed in the root directory of your application. - iOS [SOON]
- Flutter [SOON]
- React Native [SOON]
You can have up to 10 active API keys that allow you to integrate SALESmanago with your mobile app. You can use them for different purposes, for example, you can use one key for the test environment and another for the production environment. For security reasons, we recommend using separate keys for Android and iOS.
All your API keys are listed in Menu → Channels → Mobile Push → Settings → Integration settings, in the API keys tab:
Here, you can see the list of all created API keys, with an indication of their expiry date and status (Active/Expired/Revoked).
To view the value of an API key, move your cursor over an item in the list and click the eye icon [A].
To access the key’s settings, click the three-dot icon [B]. Here, you can revoke an API key, i.e., make it permanently invalid.
To create another API key, click button [C].