A mobile app developer can add and configure iOS or Android apps to Acoustic Campaign. A new app can be designated for use in a production or development (i.e., testing) environment. The push service type can also be designated as either Android or iOS.
You can manage your mobile apps from the developer resources page. Developer resources are available through the user interface if your administrator has enabled mobile push notifications for your organization. Keep in mind that you can edit or rename an app, but you can't delete it.
Important: If you have apps with the push service type set to FCM, the legacy Google API key authentication will be deprecated starting June 20th, 2024. You must update to the latest Firebase Cloud Messaging API (v1).
To update the existing apps from the legacy API key to v1:
- Go to Mobile > Developer resources > Apps.
- Click the Push Service table column to list all apps with FCM push service type.
- Click Edit for the app you want to update.
- Click Change for the Google API key field.
- From the Type of authentication dropdown field, select V1.
- You must generate a new account key from the Firebase console for your app's project and upload the generated JSON file containing the service account authentication key. To generate your app's account key from the Firebase console, go to Project settings > Service Accounts tab and click Generate new private key. The new key is generated and downloaded as a JSON file. Save the downloaded file.
- Add the Project ID of the Firebase project for your app from the Firebase console. You can get the Project ID from the Project settings > General tab.
- Click Save.
Warning: Updating the values in an app key can result in push-send failures if any of the values are incorrect. If you need to update your Google Server API key, Apple P12, or Apple P8 information on any existing app key, make the change, wait 61 minutes, and then send a test push to a device under your control. If your push fails, double-check your information, correct errors as needed, and contact support if you continue to experience push-send problems.
Create a New mobile app
- Go to Mobile > Developer resources > Apps.
- Click New app and enter a name and brief description of the app.
- Choose a time zone.
- Choose whether you want to send unread inbox counts as badges.
- Choose the environment where you want to use this app, either Production or Development.
- Select your push service type: FCM (Firebase Cloud Messaging) for Android or APNS (Apple Push Notification Service) for iOS.
FCM (Firebase Cloud Messaging) for Android
You must generate an account key from the Firebase console for your app's project and upload the generated JSON file containing the service account authentication key.
To generate your app's account key from the Firebase console, go to Project settings > Service Accounts tab and click Generate new private key. The new key is generated and downloaded as a JSON file. Save the downloaded file.
- From the Type of authentication dropdown field, select V1.
Note: The legacy Google API key authentication will be deprecated June 20th, 2024. Therefore, we recommend you use the latest Firebase Cloud Messaging API(v1) for your new apps. - Upload the JSON file containing the service account authentication key you downloaded and saved.
- Add the Project ID of the Firebase project for your app from the Firebase console. You can get the Project ID from the Project settings > General tab.
APNS (Apple Push Notification Service) for iOS
APNS mobile app setup for iOS allows for both p8 and p12 authentication. Mobile app information for each type of authentication is provided when the app is registered with Apple. Verify that the app key information matches the correct environment type.
- P8 authentication requires the following details:
- authentication key file
- authentication key ID
- team ID
- bundle ID
- P12 authentication requires the certificate file and password.
- From the Type of authentication dropdown field, select V1.
- Click Save.
Update an existing mobile app
- Go to Mobile > Developer resources > Apps.
- Locate the existing app key you want to modify and click Edit.
- Edit fields as needed.
If you are updating your legacy FCM API key to the new v1 API support, you must generate an account key from the Firebase console for your app's project and upload the generated JSON file containing the service account authentication key.
- To generate your app's account key from the Firebase console, go to Project settings Service Accounts tab and click Generate new private key. The new key is generated and downloaded as a JSON file. Save the downloaded file.
- From the Type of authentication line, click Change.
- Select V1 from the drop-down field.
- Note: The legacy Google API key authentication will be deprecated June 20, 2024. Therefore, we recommend you use the latest Firebase Cloud Messaging API (v1) for this field.
- Upload the JSON file containing the service account authentication key you downloaded and saved.
- Add the Project ID of the Firebase project for your app from the Firebase console. You can get the Project ID from the Project settings General tab.
- Click Save.
If you are changing the type of authentication you are using for your iOS app key, this information is provided when the app is registered with Apple (p12 or P8 authentication). Verify that the app key information matches the correct environment type.
- From the Type of authentication line, click Change.
- Select P12 or P8 from the drop-down field. If P8 authentication, enter the following details: authentication key file authentication key ID team ID bundle ID If P12 authentication, upload the certificate file and enter the password.
- Click Save.
Check out additional tutorials and download our SDKs in our developer experience.