Developer onboarding

Get credentials, then choose your integration path.

The Portal is the source for your PassKit credentials and regional API configuration. Keep those prerequisites separate from the QuickStarts, SDKs, Postman collection and REST reference below.

1. Obtain your credentials

Create a PassKit account, or sign in.
Open Developer Tools in the PassKit Portal.
Use the API region, API prefix and SDK credentials supplied for your account. The Portal also provides the SDK host and port where applicable.

Credentials and account-specific regional configuration are not embedded in the Swagger files or this site. Keep them in your project’s secure configuration rather than copying them into requests or source control.

Open Developer Tools

REST and gRPC

The API reference pages in this site render the committed Swagger 2.0 documents for REST operations.

Official SDKs and QuickStarts are gRPC-oriented where supported. Check Developer Tools for the SDK host and port assigned to your API region.

REST authentication

For direct REST integrations, use a dynamically generated JWT where possible. Long-lived tokens provide full, permanent API access and are intended only for legacy systems that cannot use an SDK or generate JWTs dynamically.

Watch how to authenticate REST requests using JWT for the recommended direct-REST approach.

Read how to use long-lived API tokens only when that legacy exception applies, including the supported generation and Authorization-header requirements.

Read the API configuration guide

2. Choose the right next resource

Use one starting point, then return to the REST reference for the exact request and schema details.

QuickStartsChoose an end-to-end example when beginning a new integration. SDKsChoose language-specific client libraries and gRPC integration support. PostmanInspect a maintained collection while testing request shapes and responses. API referencesBrowse operations, parameters, schemas and generated JSON examples by API area.

3. Shared integration concerns

Keep credentials secure

Keep SDK credentials and account-specific API configuration in secure project configuration. Do not place them in source control, browser code, examples or support requests.

Errors and rate limits

This repository does not contain a published platform-wide rate-limit policy or a shared error contract. Use the status codes and response models documented for the operation you are calling. Confirm production usage limits or policy questions with PassKit Support.