PassKit QuickStarts are example projects designed to help developers get started with the PassKit SDKs and API.
The QuickStarts provide working examples for common PassKit operations, allowing you to configure your credentials, connect to PassKit and test API functionality before implementing it in your own application.
We recommend starting with the QuickStart for your preferred programming language before building your PassKit integration.
Choose a QuickStart
PassKit provides QuickStarts and SDK examples for the following programming languages:
Choose your preferred language above, then download or clone the repository. Each repository README contains the current prerequisites, configuration instructions and commands for running the examples.
Before You Start
Before using a QuickStart, you will need:
A PassKit account.
Your PassKit SDK credentials.
The development environment required for your chosen programming language.
An Apple Wallet certificate ID if you are working with boarding passes.
Additional requirements vary depending on the programming language you are using. Check the README of your chosen QuickStart before getting started.
Get Your PassKit SDK Credentials
The PassKit SDKs use SDK credentials to authenticate with the PassKit API.
To generate your credentials:
Log in to your PassKit account.
Click your account icon in the bottom-left corner, then select Account from the menu.
Select Developer Tools.
Locate SDK Credentials under Account Credentials.
Follow the instructions to generate and download your credentials.
Your credentials contain the files required by the SDK to establish a secure connection with PassKit.
The exact credential configuration varies between SDKs, so follow the instructions in the README for your chosen QuickStart.
Important: Your SDK credentials should be kept private. Do not commit credentials, private keys or other secrets to GitHub or another source control repository.
Check Your API Region
When configuring your QuickStart, make sure you connect to the API region associated with your PassKit account.
You can find your API region from Developer Tools in your PassKit account.
For gRPC connections, use the host for your PassKit account region:
Europe: grpc.pub1.passkit.io
United States: grpc.pub2.passkit.io
Use the region shown in your PassKit account when configuring your application.
Set Up the QuickStart
Once you have chosen your programming language:
Download or clone the relevant repository from the PassKit GitHub organisation.
Install the prerequisites and dependencies listed in the repository README.
Add your PassKit SDK credentials as described in the configuration instructions.
Configure the QuickStart to use your PassKit API region.
Follow the README instructions to run the QuickStart.
The setup process and commands are different for each programming language, so always refer to the repository README for the latest instructions.
Run the Examples
Once the QuickStart is configured, you can use the included examples to test different PassKit features.
Depending on the SDK and QuickStart, examples may be available for:
Membership and loyalty cards
Coupons
Event tickets
Boarding passes
The examples demonstrate common API operations such as creating the required PassKit objects, issuing passes, updating records and performing actions such as redeeming coupons or validating tickets.
The exact examples available vary between QuickStarts. Refer to the README and source code in your chosen repository for the available examples and instructions for running them.
Note: Some QuickStarts can create multiple objects in your PassKit account when run. Review the examples before running them and remove or disable any examples you do not want to execute.
Using the QuickStart in Your Own Application
The QuickStarts are designed as working examples that you can use as a reference when building your own PassKit integration.
We recommend running the original QuickStart successfully before modifying the examples or moving the code into your own application.
Once the QuickStart is working:
Find the example that most closely matches the functionality you want to implement.
Review how the QuickStart establishes the connection to PassKit.
Review the request and response objects used by the example.
Identify the SDK methods required for your integration.
Adapt the example for your own application and data.
Test your implementation before using it in production.
Starting with a working QuickStart can also make troubleshooting easier by helping determine whether an issue is related to your PassKit configuration or your own implementation.
Next Steps
For detailed setup instructions and examples for your chosen programming language, refer to the relevant QuickStart or SDK repository in the PassKit GitHub organisation.
You can also use the PassKit developer documentation to find the available API methods, request fields and response definitions when building your integration.