Page: Configuring Apps for Push
Page: Configure a JMS Server
Page: Predefined App Properties
Page: Identifying Push Recipients
Page: Triggering Push Requests in a Route
Page: Custom Push Module
Page: Command-line Management Utility
Page: Push Module
Page: Allow Cross Origin Requests in a Browser App
Page: Opting Into Notifications
Page: Overview of Push
Configuring Apps for Push
Before you can send push notifications to devices that installed your app, you must configure the client app with the notification services. The Akula Server supports connecting to the following notification services:
- Android – Google Cloud Messaging (GCM)
- iOS – Apple Push Notification Service (APNS)
This section describes the following topics:
Setting up GCM
To use an Android client app with GCM, you must create a GCM account in the Google API Console. You then get the following for your app:
- Project Number – The ID for your app project, as assigned by Google in the Google API Console. You set this value in your client app during development.
- API Key – An app-specific key that identifies your app, as assigned by Google in the Google API Console. You register this key with the Akula Server.
The Project Number and API key are valid only for a single app. You cannot use them across different apps. For more information on getting started with push on Android, see http://developer.android.com/google/gcm/gs.html.
Getting a Project Number
To get a Project Number for your app:
- Create a new project in the Google API Console.
- Select Overview. The Project Number is displayed:
- Save the Project Number. When developing the client app, you pass this value during GCM registration.
Getting an API Key
To get an API Key for your app:
- Log into the Google API Console.
- Enable the "Google Cloud Messaging for Android" service.
- Select APIs & Auth > Credentials.
- Click the Create New Key button. The following dialog appears:
Note: Your experience might appear different, depending on the version of the Google API Console that you use.
- Create a new API key by clicking the Server Key button. The following dialog appears:
- (Optional) Enter IP addresses in the box at the bottom. This is a whitelist of IP addresses that can send push requests for your app. You can add or edit this list of IP addresses at a later time.
- Click the Create button.
- The Google API Console generates an API key for you:
- Register the API key with the Akula Server by using the Akula Server Management Console. This value is encrypted in the Akula database.
You can also use the REST API or Python console to register the API key with the Akula Server. For more information, see Push REST API.
Setting up APNS
To configure an iOS app to allow push notifications through APNS, use the Apple Developer Program to do the following:
- Set up an App ID for your app.
- Enable the Push Notifications service for that App ID.
- Create a provisioning profile for that App ID.
- Get an APNS certificate. The certificate can be a development or production mode certificate. After you get the APNS certificate, add the certificate to your keychain, and then export it as a .p12 file by using Keychain Access.
For more information, see the following sites:
In the Akula Server Management Console:
- Store the APNS certificate for the app scope.
- Set the password (certificate secret) that you used to export the .p12 file from the keychain.
- Specify whether your app uses the sandbox or production mode APNS environment.
You can also upload the certificate, set the secret, and toggle sandbox mode by using the Akula push REST API, the Akula Command-line Management Utility, and the Akula Management Console. For more information on using the push REST API, see Push REST API. For more information on using the command-line utility, see Using the Akula Command-line Management Utility. For more information on using the Akula Management Console, see Using the Akula Management Console.