Installation & setup | laravel-mobile-pass | Spatie SPATIE Laravel Mobile Pass ====================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-mobile-pass](https://spatie.be/docs/laravel-mobile-pass/v1) Installation & setup Version v1 Other versions for crawler [v1](https://spatie.be/docs/laravel-mobile-pass/v1) Installation & setup - [ Introduction ](https://spatie.be/docs/laravel-mobile-pass/v1/introduction) - [ Support us ](https://spatie.be/docs/laravel-mobile-pass/v1/support-us) - [ Requirements ](https://spatie.be/docs/laravel-mobile-pass/v1/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-mobile-pass/v1/installation-setup) - [ Getting credentials from Apple ](https://spatie.be/docs/laravel-mobile-pass/v1/getting-credentials-from-apple) - [ Getting credentials from Google ](https://spatie.be/docs/laravel-mobile-pass/v1/getting-credentials-from-google) - [ Questions and issues ](https://spatie.be/docs/laravel-mobile-pass/v1/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-mobile-pass/v1/changelog) - [ About us ](https://spatie.be/docs/laravel-mobile-pass/v1/about-us) Basic usage ----------- - [ Generating your first pass ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/generating-your-first-pass) - [ Delivering passes to users ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/handing-out-passes) - [ Adding images ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/adding-images) - [ Adding barcodes ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/adding-barcodes) - [ Updating a pass ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/updating-a-pass) - [ Retrieving mobile passes ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/retrieving-mobile-passes) - [ Expiring passes ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/expiring-passes) Available pass types -------------------- - [ Introduction ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/introduction) - [ Boarding pass ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/boarding-pass) - [ Event ticket ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/event-ticket) - [ Coupon ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/coupon) - [ Loyalty card ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/loyalty) - [ Generic ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/generic) Apple Wallet ------------ - [ Field zones ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/field-zones) - [ Apple-specific methods ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/apple-specific-methods) - [ Pass relevance ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/pass-relevance) - [ NFC passes ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/nfc) - [ Attaching Wi-Fi credentials ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/attaching-wifi-credentials) - [ Storing mobile passes ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/storing-mobile-passes) Google Wallet ------------- - [ Pass classes ](https://spatie.be/docs/laravel-mobile-pass/v1/google-wallet/pass-classes) - [ Object methods ](https://spatie.be/docs/laravel-mobile-pass/v1/google-wallet/object-methods) - [ Hosting pass images ](https://spatie.be/docs/laravel-mobile-pass/v1/google-wallet/hosting-images) Advanced usage -------------- - [ Handling errors ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/handling-errors) - [ Customizing actions ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/customizing-actions) - [ Customizing models ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/customizing-models) - [ Reading stored passes ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/reading-stored-passes) - [ Events ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/events) - [ Testing your passes ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/testing-your-passes) Installation & setup ======================== ### On this page 1. [ Getting credentials from Apple and Google ](#content-getting-credentials-from-apple-and-google) 2. [ Publishing the config file ](#content-publishing-the-config-file) 3. [ Migrating the database ](#content-migrating-the-database) 4. [ Registering the routes ](#content-registering-the-routes) 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-apple) - [Getting credentials from Google](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(); ``` A good match? ------------- ### What we do best - All things Laravel - Custom frontend components - Building APIs - AI-powered features - Simplifying things - Clean solutions - Integrating services ### Not our cup of tea - WordPress themes - Cutting corners - Free mockups to win a job - "Just execute the briefing" In short: we'd like to be a **substantial part** of your project. [ Get in touch via email ](mailto:info@spatie.be?subject=A%20good%20match%21&body=Tell%20us%20as%20much%20as%20you%20can%20about%0A-%20your%20online%20project%0A-%20your%20planning%0A-%20your%20budget%0A-%20%E2%80%A6%0A%0AAnything%20that%20helps%20us%20to%20start%20straightforward%21)