Installation & setup

Pull the package in with Composer:

composer require spatie/laravel-mobile-pass

##Getting credentials from Apple and Google

Each platform wants its own credentials before you can issue passes. Follow the walkthrough for whichever platforms you plan to support:

• Getting credentials from Apple
• Getting credentials from Google

Each guide walks you through what to register, which keys to download, and the environment variables to set.

##Publishing the config file

You can publish the laravel-mobile-pass config if you want to tweak it:

php artisan vendor:publish --tag="mobile-pass-config"

Here's what the published file looks like:

return [
    /*
     * Read the "Getting credentials from Apple" section in the documentation
     * to learn how to get these values.
     */
    'apple' => [
        'organization_name' => env('MOBILE_PASS_APPLE_ORGANIZATION_NAME'),
        'type_identifier' => env('MOBILE_PASS_APPLE_TYPE_IDENTIFIER'),
        'team_identifier' => env('MOBILE_PASS_APPLE_TEAM_IDENTIFIER'),

        'certificate' => env('MOBILE_PASS_APPLE_CERTIFICATE'),
        'certificate_path' => env('MOBILE_PASS_APPLE_CERTIFICATE_PATH'),
        'certificate_password' => env('MOBILE_PASS_APPLE_CERTIFICATE_PASSWORD'),

        'apple_push_base_url' => 'https://api.push.apple.com/3/device',
        'webservice' => [
            'secret' => env('MOBILE_PASS_APPLE_WEBSERVICE_SECRET'),
            'host' => env('MOBILE_PASS_APPLE_WEBSERVICE_HOST'),
        ],
    ],

    /*
     * Read the "Getting credentials from Google" section in the documentation
     * to learn how to get these values.
     */
    'google' => [
        'issuer_id' => env('MOBILE_PASS_GOOGLE_ISSUER_ID'),

        'service_account_key' => env('MOBILE_PASS_GOOGLE_KEY'),
        'service_account_key_path' => env('MOBILE_PASS_GOOGLE_KEY_PATH'),

        'origins' => [env('APP_URL')],

        'api_base_url' => env(
            'MOBILE_PASS_GOOGLE_API_BASE_URL',
            'https://walletobjects.googleapis.com/walletobjects/v1'
        ),
    ],

    /*
     * The actions perform core tasks offered by this package. You can customize the behaviour
     * by creating your own action class that extend the one that ships with the package.
     */
    'actions' => [
        'handle_google_callback' => Spatie\LaravelMobilePass\Actions\Google\HandleGoogleCallbackAction::class,
        'notify_apple_of_pass_update' => Spatie\LaravelMobilePass\Actions\Apple\NotifyAppleOfPassUpdateAction::class,
        'notify_google_of_pass_update' => Spatie\LaravelMobilePass\Actions\Google\NotifyGoogleOfPassUpdateAction::class,
        'register_device' => Spatie\LaravelMobilePass\Actions\Apple\RegisterDeviceAction::class,
        'unregister_device' => Spatie\LaravelMobilePass\Actions\Apple\UnregisterDeviceAction::class,
    ],

    /*
     * These are the models used by this package. You can replace them with
     * your own models by extending the ones that ship with the package.
     */
    'models' => [
        'mobile_pass' => Spatie\LaravelMobilePass\Models\MobilePass::class,
        'apple_mobile_pass_registration' => Spatie\LaravelMobilePass\Models\Apple\AppleMobilePassRegistration::class,
        'apple_mobile_pass_device' => Spatie\LaravelMobilePass\Models\Apple\AppleMobilePassDevice::class,
        'google_mobile_pass_event' => Spatie\LaravelMobilePass\Models\Google\GoogleMobilePassEvent::class,
    ],

    /*
     * Register custom pass builders here. Built-in builders are registered
     * automatically, so only add entries for builders you have authored yourself.
     * The array is keyed by the builder's snake_case name.
     */
    'builders' => [
        'apple' => [
            // 'my_custom_apple_pass' => MyCustomApplePassBuilder::class,
        ],
        'google' => [
            // 'my_custom_google_pass' => MyCustomGooglePassBuilder::class,
        ],
    ],

    /*
     * The queue connection and name used for pushing pass updates to the Apple and Google
     * wallet APIs. When the connection is `null`, updates will run synchronously.
     */
    'queue' => [
        'connection' => env('MOBILE_PASS_QUEUE_CONNECTION'),
        'name' => env('MOBILE_PASS_QUEUE_NAME', 'default'),
    ],
];

##Migrating the database

The package keeps track of generated passes, Apple device registrations, and Google save/remove events in your database. Publish and run the included migration:

php artisan vendor:publish --tag="mobile-pass-migrations"
php artisan migrate

The published create_mobile_pass_tables migration creates four tables: mobile_passes, apple_mobile_pass_devices, apple_mobile_pass_registrations, and mobile_pass_google_events.

##Registering the routes

Apple needs to reach your app to register devices and log errors. To wire up the routes it calls into, drop the mobilePass macro into your routes file:

// in your routes file
Route::mobilePass();