Control Panel User's Manual Push Notifications Management
last update 2015-9-16

Preparation

What You Need Before Push Notification Deliveries

Activating “External Device Push API”

By switching this ON enables “External Device Push API” .
However, you may still use the normal Push Notification features even if the switch is OFF .
It only controls whether to allow/disallow access from the external resources to Appiaries Push API.

In the app you are working on, select “Push Notification”.
On your Push Notification Management page, select “Basic Settings” .

By switching the “Device Push” button ON , enables the External Device Push API.
Likewise, switching OFF to disable the API.

Market Settings

For Appiaries Push Notification service depends on Apple Push Notification Serivce (APNs) for iOS,
and Google Messaging Service (GCM) for Android,
we need corresponding information from the markets.

APNs

You need “p12 Certificate” file from APNs.
Read the instructions available in the following article to configure your settings.

GCM

You need “API Key” from GCM.
Read the instructions available in the following article to configure your settings.

Associating Appiaries To APNs/GCM Market

We are associating your app on Appiaries to what obtained from APNs/GCM.

On your Push Notification Management page, select “Market Setup” .

You can configure your settings on “Market Setup” page to associate the your app with APNs/GCM information.

APNs

By registering the forllowing items, you can deliver Push Notifications to iOS devices.

Items Descriptions
Destination Select “Sandbox” or “Production in accord with the application type
you have chosen in iOS Developers website.
Certificate Click “Choose File” to upload your “p12 Certificate” file.
Password Register the password associated with the above “p12 Certificate”.
Your Push Notifications will not be delivered if the password is incorrect.
Expiration Date You may set any date you wish. Once exceeds the set date, you may not deliver Push Notifications.
When you are re-setting a new date, you need the certificate once again.

(*) When you are re-setting any of the above items, you are required ALL of the above items ready.

Freely Customized Data for iOS Devices

You may send the following customizable data along with the Push Notification message you deliver.
You are not setting these customizable data on “Market Setup” but setting them on “Message Setup” page
(which will be discussed in the following chapters).

Keys Descriptions
Message (alert) This is the title which appears on top of the Push Notification dialog when you receive them.
Badge This will appear as a number (badge) next to the app icon on your notification region.
You may set up to 9223372036854775807.
If you set a number which exceeds the limit, 9223372036854775807 is set.
Sound You may specify the path for sound files when the messages are received.
Rich Push URL (_openUrl) Specifying a certain URL and enables users to click.

GCM

By registering “API Key”, you can deliver Push Notifications to Android devices.

Freely Customized Data for Android Devices

You can set default “Custom Keys” up to 5 for which you will set corresponding keys,
and they will be delivered along with the Push Notification message you deliver.
However, if you are planning to use “Rich Push URL” feature or use “Custom Dialog”,
you need the following 2 custom keys to be set in order for these features to properly work.

Keys Description
title Appears as TITLE for your Push Notification Dialog.
message Appears as MESSAGE for your Push Notification Dialog.