Documentation
Help CenterCommunityDevelopersAcademyStatus

Get an access key for the Campaign library

Suggest Edits

To activate the Campaign library within your mobile app, you must upload the app's push certificate to Acoustic Campaign and generate an access key based on the certificate.

Requirements

  • If you have an iOS app, you must use Apple Developer Program membership for it. Free accounts do not support push notifications.
  • You need a developer account for Acoustic Campaign. The account must have the following permissions enabled: Enable Mobile App Push and Enable Development for Mobile App Push.

Before you begin

Before you begin, make sure the following conditions are met.

Your Android app must be registered with Firebase. See Add Firebase to your Android project in the Firebase guide.

  • Your iOS project must use an explicit App ID and be assigned to a team. For the App ID, the push notification service must be enabled.
  • In your iOS project, the Push Notifications capability must be enabled. For instructions, see Adding capabilities to your app in the Xcode guide.
  • Your app must be registered with Apple Push Notification service (APNs). You can use either of the following authentication methods to secure connection to APNs: token-based (p8) (recommended by Apple) or certificate-based (p12).

📘

Important

The provisioning profile must match the push certificate. For example, a development provisioning profile works with a development push certificate.

Instructions

  1. Log in to Acoustic Campaign under a developer account.
  2. In the navigation menu, select Administration > Push developer resources > Apps.
Push developer resources
  1. Click to add a new app.
  2. Fill out the required settings and save the changes.
App key settings
  1. Copy your app key and keep it handy for the integration.
Copy access key from Campaign

Platform-specific settings

Here are settings for Android apps.

  1. In the Push Service field, select GCM/FCM.
Push notification service selection for Android
  1. Set the type of authentication to V1.
  2. Provide required credentials for the selected authentication type.

Here are settings for iOS apps.

  1. In the Push Service field, select APNs.
  2. Set the Type setting in accordance with the distribution model. Select Development to run the app from Xcode with a development provisioning profile. Or select Production to run the app with an App Store, Enterprise, or ad hoc provisioning profile.
  3. Select the type of authentication to use: P8 or P12.
  4. Provide required credentials for the selected authentication type.
Authentication typeCredentials to submit to Acoustic Campaign
Token-based (p8)1) An authentication token signing key, which is a text file with the .p8 extension
2) A 10-character string with the Key ID
3) The Team ID associated with your app
4) The Bundle ID assigned to your app
Certificated-based (p12) 1) A certificate file with the .p12 extension
2) CSR (a private key used to encrypt the certificate)

Updated 9 days ago