How to use the PassKit Python SDK

The QuickStart includes examples for:

This guide will help you configure your credentials, run the Python QuickStart and test the included examples.

Before using the Python QuickStart, you will need:

The Python QuickStart is available from the PassKit Python QuickStart repository.

Clone the repository:

Create a Python virtual environment:

On macOS or Linux, activate the virtual environment with:

On Windows PowerShell:

Then install the QuickStart and its dependencies:

The PassKit SDK uses SDK credentials to securely authenticate with the PassKit API.

To generate and download your SDK credentials:

When generating your SDK credentials, you will be asked to create a password. This password encrypts your private key and is separate from your PassKit account password.

Your SDK credentials contain three files:

Keep your SDK credential password and credential files secure.

In the root of the QuickStart repository, create a folder named:

Add all three SDK credential files to this folder.

Your project should contain:

You do not need to manually decrypt key.pem. The QuickStart can use the encrypted private key with the password you created when generating your SDK credentials.

The certs folder is ignored by Git to help prevent your credentials from being committed to source control.

Create your local .env file by copying .env.example:

Open .env and set PASSKIT_PASSPHRASE to the password you created when generating your SDK credentials.

Your credential paths are configured to use:

Both your .env file and SDK credentials should remain private and should not be committed to source control.

Your QuickStart must connect to the API region associated with your PassKit account.

You can find your API region under Developer Tools → API Region in your PassKit account.

For gRPC connections, use:

Europe

United States

Set PASSKIT_ADDRESS in your .env file to the appropriate hostname.

For example:

The default gRPC port is:

Make sure the API region matches the region shown in your PassKit account.

Once your credentials and .env file have been configured, you can run one of the four guided examples.

You can also use:

You can also use:

Each workflow creates the resources required for the example and performs a series of common PassKit API operations.

When an example completes successfully, the QuickStart outputs a PassKit pass URL.

Open the URL on a compatible mobile device to add the pass to Apple Wallet or Google Wallet.

If you open the URL on a desktop, the PassKit page displays a QR code that you can scan with your phone.

Each workflow demonstrates common operations available through the PassKit Python SDK.

The membership workflow demonstrates operations including:

The coupons workflow demonstrates operations including:

The event tickets workflow demonstrates operations including:

The flights workflow demonstrates operations including:

The flights workflow requires an Apple Wallet pass certificate to be uploaded to your PassKit account.

Add the Pass Type Identifier for your Apple Wallet certificate to .env:

Replace the example value with your own Pass Type Identifier.

The QuickStart uses default carrier and airport codes for the example. If those resources already exist in your account, they are reused rather than recreated.

Reused carrier and airport resources are not deleted during cleanup.

By default, the QuickStart removes the test resources it creates after running a workflow.

Cleanup also runs if an example fails partway through, helping prevent test resources from accumulating in your PassKit account.

If you want to keep the generated resources so you can inspect them, set the following value in .env:

You will then need to remove the generated resources manually.

For normal QuickStart use, leave:

If you want the QuickStart to send a generated pass to an email address, set:

to the email address you want to use.

For example:

Leave this value empty if you do not want to send a welcome email.

The guided workflows provide examples of common PassKit operations, but the Python SDK contains additional methods that you can use in your own application.

To view the operations currently exposed through the QuickStart, run:

This command does not require SDK credentials or a connection to PassKit.

The individual product folders also contain reusable methods for:

You can use these implementations as a reference when building your own integration.

Confirm that all three credential files are inside the certs folder:

Also make sure you are running the QuickStart commands from the repository root.

Check the value of:

This must be the password you created when generating your SDK credentials, not your PassKit account password.

If you generate a new set of SDK credentials, replace all three credential files together.

Check Developer Tools → API Region in your PassKit account and confirm that PASSKIT_ADDRESS matches your account:

for Europe, or:

for the United States.

Also check whether a firewall or VPN is blocking outbound HTTPS or gRPC traffic.

Confirm that an Apple Wallet certificate has been uploaded to PassKit and that its Pass Type Identifier has been added to:

The QuickStart attempts to clean up the resources created during each workflow.

If resources remain, check the terminal output for cleanup errors and remove the remaining resources from your PassKit account.

Also confirm that:

Once you have successfully run the Python QuickStart, you can use the examples and reusable methods as a reference when implementing PassKit in your own Python application.

For additional methods, request fields and response definitions, refer to the PassKit developer documentation.