APNs PHP

This module integrates edamov/pushok as a Drupal service, providing a wrapper for sending push notifications to Apple devices through the Apple Push Notification service (APNs).

This module is a community implementation and is not affiliated with the edamov/pushok project.

This is a developer module — you will need to write code against the service it exposes for it to be useful.

Warning: This is an API module and is not finalized. It could change at any time.

Submit bug reports and feature suggestions, or track changes in the issue queue.

Push Notifications for Mobile Apps

This module is part of a suite of modules for sending push notifications to mobile apps while maximizing user privacy; see the docs for an overview and installation instructions for all modules.

Table of contents

• Requirements
• Installation
• Configuration
• FAQ
• Maintainers

Requirements

This module requires no modules outside of Drupal core.

The edamov/pushok library is pulled in automatically via Composer.

Installation

Install as you would normally install a contributed Drupal module. For further information, see Installing Drupal Modules.

Configuration

1. Enable the module at Administration » Extend.
2. At /admin/config/system/apns_php, set the team ID, key ID, app bundle ID, certificate path, and certificate secret.

How to get the configuration credentials

You will need an Apple Developer account.

See Apple's documentation: Get a key identifier.

1. Go to Keys.
2. Create a new key for sandbox and another for production (or a single key for both).
3. Give the key a name and select APNs.
4. Configure the key using the button (set the environment).
5. If you want to restrict the key to just a single app, set the "Key restriction" to "Topic Specific" and the topic to the app bundle ID.
6. Register the key.

Do NOT commit the key to your repository.

You need to know the Key ID.

If your private files directory is inside your webroot, move it outside your webroot. (If your host doesn't let you do this, get a new host.)

FAQ

Q: How can I send a test message?

A: Go to /admin/config/system/apns_php/test.