5 March 2015
User level: All
Required Adobe products (retail)
Additional required other products (third-party/labs/open source)
By downloading software from the Adobe website you agree to the terms of our license agreement. Please read it before downloading.
Using the push notification API, you can send push notifications in a programmatic way to Apps built with Adobe DPS.
This article gives an overview of the examples of this API. Each of the PHP snippets generates a request to one of the many Push functionalities available through the push notification API. When you finish reading this article, you will be able to understand how to make the API requests and the formats of their respective parameters.
Please note that the current version of the push notification API only supports iOS.
Please download dps-push-notification-php-snippets.zip. Extract the file into the default folder named dps-push-notification-php-snippets. Please select a location for this folder that can be easily found, as it will be utilized throughout this article. This folder contains all the code snippets that are necessary to interact with the push notification API.
Every software-client that wants to consume the Adobe Push Notification API has to request an API Key (also known as IMS client ID), with corresponding secret.
API Key/IMS Client ID
The Digital Publishing Suite account used in this article will require an application role. Please read this article to know how you can assign an application role to a DPS account.
The Push Notification service requires a valid Sandbox (aka Development) and Production certificates with Push enabled. Please follow this guide to create the iOS Push certificates. Please move the two .p12 certificates (development and distribution) into the folder call certificate within the root directory of the dps-push-notification-php-snippets folder, and rename the developer and distribution .p12 certificates into aps_development_bootcamp.p12 and aps_production_bootcamp.p12, respectively.
The PHP snippet utilizes three files that store the login and API parameters: credentials.php, endpoints.php, and parameters.php. The files are located within the config folder from the root directory of the dps-push-notification-php-snippets folder.
All parameters are currently commented out in the mentioned three files. Please uncomment each parameters before use by deleting the double backslash (“//”) in front of each parameter. To enter the desired value for a parameter, please enter it within the single quotes next to the parameter’s name.
Please upload all the contents within the dps-push-notification-php-snippets folder to a hosting server. Since the PHP snippets utilizes PHP, the hosting server must have PHP installed.
Each of the PHP files contains a HTTPS request to the push notification API server, and will output the results of that API request. Please load the PHP files from the hosting server to make the HTTPS request.
The folders mentioned below are within the dps-push-notification-push-snippets folder. It is not necessary to make any modifications to the PHP snippets mentioned below, they will operate as configured.
For more information about the individual Push Notification API, please refer to this PDF .
Comments are currently closed as we migrate to a new commenting system. In the interim, please provide any feedback using our feedback form. Thank you for your patience.