README

This package provides a simple OOP integration of the Apple Wallet passes (PassKit) API for your PHP project.

Installation

$ composer require laulamanapps/apple-passbook

Or use one of the framework integrations, which also implement the Apple PassKit web service endpoints for pass updates:

If you're using Symfony, install laulamanapps/apple-passbook-bundle:

$ composer require laulamanapps/apple-passbook-bundle

If you're using Laravel, install laulamanapps/apple-passbook-laravel:

$ composer require laulamanapps/apple-passbook-laravel

Run Tests

We use act to run tests which runs github actions locally:

$ act -P ubuntu-latest=shivammathur/node:latest

Get certificate

Head over to the Apple Developer Portal to get yourself a certificate to sign your passbooks with.

Convert the certificate and key to a .p12 file using the Keychain Access

Setup Compiler

use LauLamanApps\ApplePassbook\Build\CompilerFactory;

$factory = new CompilerFactory();
$compiler = $factory->getCompiler('<PathToCertificate>', '<CertificatePassword>');

AppleWWDRCA certificate.

Included are 4 AppleWWDRCA intermediate certificates:

AppleWWDRCAG3.pem - Expires Feb 20 2030 (fallback default)
AppleWWDRCAG4.pem - Expires Dec 10 2030
AppleWWDRCAG5.pem - Expires Dec 10 2030
AppleWWDRCAG6.pem - Expires Mar 19 2036

The Signer automatically selects the bundled intermediate that matches the issuer of your pass type identifier certificate (G3–G6), so in most cases no configuration is needed. To override the selection, set a file path as the 3rd option of the CompilerFactory or call setAppleWWDRCA() on the Signer class.

Create Passbook

use LauLamanApps\ApplePassbook\EventTicketPassbook;
use LauLamanApps\ApplePassbook\MetaData\Barcode;
use LauLamanApps\ApplePassbook\MetaData\Field\Field;
use LauLamanApps\ApplePassbook\MetaData\Image\LocalImage;
use LauLamanApps\ApplePassbook\MetaData\Location;
use LauLamanApps\ApplePassbook\Style\BarcodeFormat;
use LauLamanApps\ApplePassbook\Style\Color\Rgb;

$passbook = new EventTicketPassbook('nmyuxofgna');
$passbook->setTeamIdentifier('<TeamId>');
$passbook->setPassTypeIdentifier('<PassTypeId>');
$passbook->setOrganizationName('Apple Inc.');
$passbook->setDescription('Apple Event Ticket');
$passbook->setRelevantDate(new DateTimeImmutable('2011-12-08T13:00-08:00'));
$passbook->setForegroundColor(new Rgb(255, 255, 255));
$passbook->setBackgroundColor(new Rgb(60, 65, 76));
$passbook->setWebService('https://example.com/passes/', 'vxwxd7J8AlNNFPS8k0a0FfUFtq0ewzFdc');

$passbook->addLocation(new Location(37.6189722, -122.3748889));
$passbook->addLocation(new Location(37.33182, -122.03118));

$barcode = new Barcode();
$barcode->setFormat(BarcodeFormat::Pdf417);
$barcode->setMessage('123456789');
$passbook->setBarcode($barcode);

$event = new Field();
$event->setKey('event');
$event->setLabel('EVENT');
$event->setValue('The Beat Goes On');
$passbook->addPrimaryField($event);

$loc = new Field();
$loc->setKey('loc');
$loc->setLabel('LOCATION');
$loc->setValue('Moscone West');
$passbook->addSecondaryField($loc);

$passbook->addImage(new LocalImage('/files/Event/background.png'));
$passbook->addImage(new LocalImage('/files/Event/icon.png'));
$passbook->addImage(new LocalImage('/files/Event/logo.png'));
$passbook->addImage(new LocalImage('/files/Event/thumbnail.png'));

Compile Passbook

header('Content-Description: File Transfer');
header('Content-Type: application/vnd.apple.pkpass');
header('Content-Disposition: filename="boardingpass.pkpass"');

echo $compiler->compile($passbook);

Push Notifications (updating passes)

When a pass is registered on a device via the web service, Apple provides a push token. You can use the Notifier to send a push notification that tells the device to fetch an updated version of the pass.

use LauLamanApps\ApplePassbook\Build\Notifier;

// Using a .p12 certificate (as provided by Apple)
$notifier = new Notifier('<PathToCertificate.p12>', '<CertificatePassword>');

// Or using a .pem certificate
$notifier = new Notifier('<PathToCertificate.pem>');

// Send a push notification to trigger a pass update
$notifier->notify('<DevicePushToken>');

For sandbox/development environments:

use LauLamanApps\ApplePassbook\Build\ApnsEnvironment;

$notifier = new Notifier('<PathToCertificate.p12>', '<CertificatePassword>', ApnsEnvironment::Sandbox);

Note: The ext-curl extension with HTTP/2 support is required.

Examples

For the examples to work place the certificate P12 file in the /certificates folder and fill out the required information in the example scripts: <CertificatePassword>, <TeamId>, <PassTypeId>

Example php scripts can be found in docs/example:

BoardingPass
BoardingPass Advanced — semantic tags, action URLs, QR barcode, beacons
Coupon
Event
Event Advanced — semantic tags, action URLs, NFC, expiration, sharing
Generic
Generic NFC — employee badge with NFC door access, beacons, Wi-Fi, data detectors
StoreCard
StoreCard NFC — NFC-enabled loyalty card with contactless authentication
Push Notification — sending pass updates via APNs

Credits

This package has been developed by LauLaman.

laulamanapps / apple-passbook

Maintainers

Package info

Statistics

Security