rajchotaliya/apple-push-notification-service

A PHP package to send push notifications using Apple's APNs.

1.4.0 2025-02-01 10:35 UTC

Requires

• php: >=8.0

MIT

• Raj Chotaliya

README

A PHP library to send push notifications to Apple devices using the APNs service.

Installation

Install the library using Composer:

composer require rajchotaliya/apple-push-notification-service

Usage

Laravel

1. Configuration :

   • Environment Variables (Required)

     Add the following entries to your .env file:

     APNS_BUNDLE_ID=your_bundle_id
     APNS_KEY_ID=your_key_id
     APNS_TEAM_ID=your_team_id
     APNS_PRIVATE_KEY_PATH=/path/to/your/AuthKey.p8

   • Publish Config File (Optional)

     After installing the package, publish the configuration file using the following Artisan command:

     php artisan vendor:publish --provider="RajChotaliya\ApplePushNotificationService\ApplePushNotificationServiceProvider"

     This will publish the apns.php file into your Laravel project's config directory. You can then customize it to fit your needs.

     Example configuration in config/apns.php:

     return  [
        'bundle_id' => env('APNS_BUNDLE_ID', ''),
        'key_id' => env('APNS_KEY_ID', ''),
        'team_id' => env('APNS_TEAM_ID', ''),
        'private_key_path' => env('APNS_PRIVATE_KEY_PATH', storage_path('AuthKey.p8')),
     ];

2. Using the Library:

   You can use the library in your Laravel application as follows:

   use RajChotaliya\ApplePushNotificationService\ApplePushNotificationService;
   
   $deviceToken = 'your_device_token';
   $title = 'Hello from APNs!';
   $body = 'This is a test push notification.';
   
   $apns = new ApplePushNotificationService($deviceToken, $title, $body);
   $response = $apns->sendNotification();

Core PHP

1. Configuration (Required) :

   Manually create a configuration file at config/apns.php in your project root directory:

   <?php
   
   return [
       'bundle_id' => 'com.example.app',
       'key_id' => 'ABC123DEF456',
       'team_id' => 'XYZ789',
       'private_key_path' => __DIR__ . '/AuthKey.p8',
   ];

2. Using the Library:

   You can use the library in a Core PHP project as follows:

   require 'vendor/autoload.php';
   
   use RajChotaliya\ApplePushNotificationService\ApplePushNotificationService;
   
   $deviceToken = 'your_device_token';
   $title = 'Hello from APNs!';
   $body = 'This is a test push notification.';
   
   $apns = new ApplePushNotificationService($deviceToken, $title, $body);
   $response = $apns->sendNotification();
   
   echo $response['message'];

Fetch JWT for Authentication (Separate Token Fetch)

• Fetch JWT for Authentication (Separate Token Fetch)

  To fetch the JWT (JSON Web Token) for authentication with Apple's APNs service, you can use the following method. This token is used for making authenticated requests to the APNs service.

  Example:

  $jwt = $apns->fetchJWT();

  The fetchJWT() method retrieves the token needed for authenticating requests, ensuring that your notifications are sent securely to the APNs service.

Features

• Laravel Support: Includes a service provider and configuration publishing for seamless integration.
• Core PHP Compatibility: Easily load configuration and use the library without a framework.
• Cross-Platform: Compatible with all PHP versions >= 8.0.

Support

Feel free to contribute or raise issues in the GitHub repository.

Show Your Appreciation

You can show your appreciation by buying me a tea through the following link:

Buy me a tea