Pushok Documentation

To send notifications, follow these steps:

1. Create an AuthProvider (JWT or Certificate).
2. Build a Payload with an Alert.
3. Create Notification objects for each device token.
4. Initialize a Client and add the notifications.
5. Call push() to send them.

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

// 1. Setup Auth (Assuming $authProvider is already created)

// 2. Create Payload
$alert = Alert::create()->setTitle('Hello!')->setBody('First push notification');
$payload = Payload::create()->setAlert($alert);
$payload->setSound('default');
$payload->setCustomValue('key', 'value');

// 3. Prepare Notifications
$deviceTokens = ['<token_1>', '<token_2>'];
$notifications = [];
foreach ($deviceTokens as $token) {
    $notifications[] = new Notification($payload, $token);
}

// 4. Send
$client = new Client($authProvider, $production = false);
$client->addNotifications($notifications);
$responses = $client->push();

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

$alert = Alert::create()->setTitle('Hello!')->setBody('First push notification');
$payload = Payload::create()->setAlert($alert);
$payload->setSound('default');
$payload->setCustomValue('key', 'value');

$deviceTokens = ['<device_token_1>', '<device_token_2>'];
$notifications = [];
foreach ($deviceTokens as $deviceToken) {
    $notifications[] = new Notification($payload, $deviceToken);
}

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

Pushok supports JWT-based authentication. You need to provide your Apple Developer credentials to create a Token auth provider.

Required options:

• key_id: The Key ID from your Apple developer account.
• team_id: The Team ID from your Apple developer account.
• app_bundle_id: The bundle ID for your app.
• private_key_path: Path to your .p8 private key file.
• private_key_secret: (Optional) Private key secret.

Note: JWT tokens expire after one hour. For long-running tasks, you must regenerate the token.

use Pushok\
AuthProvider\\Token;

$options = [
    'key_id' => 'AAAABBBBCC',
    'team_id' => 'DDDDEEEEFF',
    'app_bundle_id' => 'com.app.Test',
    'private_key_path' => __DIR__ . '/private_key.p8',
    'private_key_secret' => null
];

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

use Pushok\AuthProvider\Token;

$options = [
    'key_id' => 'AAAABBBBCC',
    'team_id' => 'DDDDEEEEFF',
    'app_bundle_id' => 'com.app.Test',
    'private_key_path' => __DIR__ . '/private_key.p8',
    'private_key_secret' => null
];

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

The push() method returns an array of ApnsResponseInterface objects. Use these to inspect the result of each notification attempt.

Available methods on the response object:

• getDeviceToken(): The device token used.
• getApnsId(): A canonical UUID unique to the notification.
• getStatusCode(): HTTP status code (e.g., 200 for success, 410 for inactive token).
• getReasonPhrase(): The HTTP reason phrase.
• getErrorReason(): Error reason (e.g., Unregistered).
• getErrorDescription(): Detailed error description.
• get410Timestamp(): Timestamp for 410 errors.

foreach ($responses as $response) {
    echo $response->getStatusCode();
    echo $response->getApnsId();
    // ... handle errors based on getStatusCode() or getErrorReason()
}

foreach ($responses as $response) {
    $response->getDeviceToken();
    $response->getApnsId();
    $response->getStatusCode();
    $response->getReasonPhrase();
    $response->getErrorReason();
    $response->getErrorDescription();
    $response->get410Timestamp();
}

The Pushok\AuthProvider\Token class implements JWT-based authentication for APNs. When creating a provider, you must provide a set of options containing your Apple developer credentials.

Required options:

• key_id: The Key ID obtained from your Apple developer account.
• team_id: The Team ID obtained from your Apple developer account.
• app_bundle_id: The bundle ID for your app.

Optional private key options (you must provide exactly one of these):

• private_key_path: The file system path to your .p8 private key file.
• private_key_content: The raw string content of your .p8 private key.
• private_key_secret: The passphrase/secret for the private key (if applicable).

$options = [
    'key_id' => 'ABC123DEFG',
    'team_id' => 'TEAMID123',
    'app_bundle_id' => 'com.example.app',
    'private_key_path' => '/path/to/AuthKey_ABC123DEFG.p8',
    // or 'private_key_content' => '...', 
    // or 'private_key_secret' => '...',
];