When integrating with PassKit, you need to know your API region, SDK host, SDK port, and API prefix to ensure your REST and gRPC calls are correctly routed. This guide walks you through where to find these details in your PassKit account, helping you set up your integration quickly and efficiently.
Terminology
API (Application Programming Interface)
A set of protocols and tools that allow different software applications to communicate with each other. PassKit provides APIs to integrate digital passes into apps, websites, and other systems.
gRPC
A high-performance, open-source framework for remote procedure calls (RPC). PassKit recommends use of gRPC for efficient communication between services.
For more details, refer to The Benefit of Interacting with PassKit over gRPC.
HTTP/HTTPS
Protocols used for transmitting data over the internet. PassKit uses HTTPS to ensure secure communication.
REST (Representational State Transfer)
An architectural style for designing networked applications. It relies on a stateless client-server communication model and uses standard HTTP methods to interact with resources.
SDK (Software Development Kit)
A collection of tools, libraries, documentation, and code samples that developers use to build applications for a specific platform, framework, or service.
Accessing Developer Tools
To find your API details, follow these steps:
Log in to your PassKit account.
Click the dropdown arrow next to your username in the top-right corner.
Select Developer Tools from the menu.
Click on API Region.
You will now see four key pieces of information:
API Region – Your assigned region (e.g. Europe or US).
SDK Host – Either
grpc.pub1.passkit.iofor the Europe Server orgrpc.pub2.passkit.iofor the US Server.SDK Port – The port number required for gRPC communication.
API Prefix – The base URL for REST API calls (
https://api.pub1.passkit.iofor the Europe Server orhttps://api.pub2.passkit.iofor the US Server).
Using These Details
For gRPC calls, you will need the SDK Host and SDK Port
For REST API calls, use the API Prefix.
By following these steps, you’ll have the correct configurations for interacting with PassKit efficiently.
For more information on using our SDKs, see How to use the PassKit Quickstarts
Please note that your API region is set at sign-up and cannot be changed. If you need to use a different region, you will need to create a new account.