Need help with pushok?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

edamov
272 Stars 90 Forks MIT License 183 Commits 16 Opened issues

Description

PHP client for Apple Push Notification Service (APNs) - Send push notifications to iOS using the new APNs HTTP/2 protocol with token-based (JWT with p8 private key)

Services available

!
?

Need anything else?

Contributors list

Pushok

PHP >= 7.2 Build Status Latest Version on Packagist Total Downloads Coverage Status Quality Score Software License

Pushok is a simple PHP library for sending push notifications to APNs.

Features

  • [X] Uses new Apple APNs HTTP/2 connection
  • [X] Supports JWT-based authentication
  • [X] Supports Certificate-based authentication
  • [X] Supports new iOS 10 features such as Collapse IDs, Subtitles and Mutable Notifications
  • [X] Uses concurrent requests to APNs
  • [X] Tested and working in APNs production environment

Requirements

  • PHP >= 7.2
  • lib-curl >= 7.46.0 (with http/2 support enabled)
  • lib-openssl >= 1.0.2e

Docker image that meets requirements can be found here. Or you can follow this tutorial to create your own docker image with curl with HTTP/2 support.

Install

Via Composer

$ composer require edamov/pushok

Getting Started

Using JWT token. See Handling Notification Responses from APNs for more info. ``` php <?php require DIR . '/vendor/autoload.php';

use Pushok\AuthProvider; use Pushok\Client; use Pushok\Notification; use Pushok\Payload; use Pushok\Payload\Alert;

$options = [ 'keyid' => 'AAAABBBBCC', // The Key ID obtained from Apple developer account 'teamid' => 'DDDDEEEEFF', // The Team ID obtained from Apple developer account 'appbundleid' => 'com.app.Test', // The bundle ID for app obtained from Apple developer account 'privatekeypath' => DIR . '/privatekey.p8', // Path to private key 'privatekey_secret' => null // Private key secret ];

// Be aware of thing that Token will stale after one hour, so you should generate it again. // Can be useful when trying to send pushes during long-running tasks $authProvider = AuthProvider\Token::create($options);

$alert = Alert::create()->setTitle('Hello!'); $alert = $alert->setBody('First push notification');

$payload = Payload::create()->setAlert($alert);

//set notification sound to default $payload->setSound('default');

//add custom value to your notification, needs to be customized $payload->setCustomValue('key', 'value');

$deviceTokens = ['', '', ''];

$notifications = []; foreach ($deviceTokens as $deviceToken) { $notifications[] = new Notification($payload,$deviceToken); }

// If you have issues with ssl-verification, you can temporarily disable it. Please see attached note. // Disable ssl verification // $client = new Client($authProvider, $production = false, [CURLOPTSSLVERIFYPEER=>false] ); $client = new Client($authProvider, $production = false); $client->addNotifications($notifications);

$responses = $client->push(); // returns an array of ApnsResponseInterface (one Response per Notification)

foreach ($responses as $response) { // The device token $response->getDeviceToken(); // A canonical UUID that is the unique ID for the notification. E.g. 123e4567-e89b-12d3-a456-4266554400a0 $response->getApnsId();

// Status code. E.g. 200 (Success), 410 (The device token is no longer active for the topic.)
$response->getStatusCode();
// E.g. The device token is no longer active for the topic.
$response->getReasonPhrase();
// E.g. Unregistered
$response->getErrorReason();
// E.g. The device token is inactive for the specified topic.
$response->getErrorDescription();
$response->get410Timestamp();

} ```

Using Certificate (.pem). Only the initilization differs from JWT code (above). Remember to include the rest of the code by yourself.

 'com.app.Test', // The bundle ID for app obtained from Apple developer account
    'certificate_path' => __DIR__ . '/private_key.pem', // Path to private key
    'certificate_secret' => null // Private key secret
];

$authProvider = AuthProvider\Certificate::create($options);

...

Note : Please see this post about ssl verification

Options to fiddle around. See Sending Notification Requests to APNs ``` php <?php

$client = new Client($authProvider, $production = false); $client->addNotifications($notifications);

// Set the number of concurrent requests sent through the multiplexed connections. Default : 20 $client->setNbConcurrentRequests( 40 );

// Set the number of maximum concurrent connections established to the APNS servers. Default : 1 $client->setMaxConcurrentConnections( 5 );

$responses = $client->push();

## Testing

``` bash $ composer test

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.