PassKit allows you to quickly and easily generate URLs (weblinks) to pass records that can include unique data, without having to use the PassKit API.
In addition to not having to use the PassKit API to create unique pass links, you can generate as many SmartPass links without creating a pass record in the PassKit database. Therefore a SmartPass link won't count toward your pass volume subscription. i.e. you can have millions of SmartPass links but not pay for millions of passes. Only when the user clicks on the link will PassKit create and issue the pass.
You can generate these SmartPass links from a CSV, although for a production integration we recommend you automate and trigger from a record being created (in a CRM for example). The SmartPass link can then be distributed in a welcome email from your CRM / email Service provider.
All you need to generate a SmartPass link is the ability to generate a link with a base64 encoded JSON payload, and create a signature HMAC hash off the link to allow PassKit to verify the data integrity.
Below is a high level flow & sample instructions.
- SmartPass links are only supported on the latest PassKit v4 platform: https://app.passkit.com. SmartPass links do not work with older versions of PassKit (Cherry Pie, and the v2/v3 API's).
- If you have a CSV of your data you can use our link generator tool, which simplifies the creation and encryption of the links for you (no code knowledge needed!): https://github.com/PassKit/smart-pass-link-from-csv-generator
Generating Hashed Smart Pass Links
1. Define JSON payload with the pass data:
The payload can contain the coupon / member, PII & meta data that needs to go into the pass record:
"person.displayName": "Patrick Kosterman",
For a full list of supported fields have a look here: https://github.com/PassKit/smart-pass-link-from-csv-generator#available-field-names
2. Base64 URL encode minified JSON payload
For above sample data:
3. Compose the link to issue the pass
The format of the link is as follows:
So for the sample data it looks like the following:
The signature hash is appended in the next step.
4. Generate hash for the link
Each PassKit project has a unique secret that is used for creating a signature HMAC hash of the link. We support the following cryptographic hash functions MD5, SHA1, SHA223, SHA256, SHA384 and SHA512 / SHA3.
For the above sample let's create a SHA256 HMAC of the sample link:
with shared secret 'patrick':
Now we can complete the link by appending the signature to it:
In addition to the hashed link functionality, we have also added the functionality for generating encrypted links.
We recommend this over hashed SmartPass links, since ultimately it is more secure than the signature hash since the whole payload is encrypted. The process for this is similar but instead of generating a signature hash for the link, you encrypt the data payload with AES CBC encryption + random IV.
The encrypted link has the format:
If you have a CSV of your data, you can use our link generator tool, which simplify creates and encrypts the links for you (no code knowledge needed!):