PKPass
From Just Solve the File Format Problem
(Difference between revisions)
Dan Tobias (Talk | contribs) m |
Ross-spencer (Talk | contribs) (Add required fields) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
}} | }} | ||
'''PKPass''' is the format of tickets, coupons, and loyalty cards used in the iOS Passbook app (and other apps designed to use the format). It is a [[ZIP]]-format archive (but using the .pkpass extension instead of .zip) containing [[JSON]]-format data along with some [[PNG]]-format images. The files within the archive have specific expected names to denote their function. | '''PKPass''' is the format of tickets, coupons, and loyalty cards used in the iOS Passbook app (and other apps designed to use the format). It is a [[ZIP]]-format archive (but using the .pkpass extension instead of .zip) containing [[JSON]]-format data along with some [[PNG]]-format images. The files within the archive have specific expected names to denote their function. | ||
| + | |||
| + | == pass.json Structure == | ||
| + | |||
| + | The <code>pass.json</code> structure is described [https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/Creating.html here] and supported with reference files. | ||
| + | |||
| + | The following fields are described as being required: | ||
| + | |||
| + | * <code>passTypeIdentifier</code> | ||
| + | * <code>serialNumber</code> | ||
| + | * <code>formatVersion</code> | ||
| + | * <code>teamIdentifier</code> | ||
| + | * <code>organizationName</code> | ||
| + | * <code>description</code> | ||
== Links == | == Links == | ||
| Line 12: | Line 25: | ||
* [http://developer.apple.com/library/ios/#documentation/PassKit/Reference/PKPass_Ref/PKPass.html PKPass class reference] | * [http://developer.apple.com/library/ios/#documentation/PassKit/Reference/PKPass_Ref/PKPass.html PKPass class reference] | ||
* [https://play.google.com/store/apps/details?id=com.attidomobile.passwallet PassWallet for Android] | * [https://play.google.com/store/apps/details?id=com.attidomobile.passwallet PassWallet for Android] | ||
| + | |||
| + | == Examples links == | ||
| + | |||
| + | * [https://reinteractive.com/articles/create-an-apple-wallet-pass-using-pass-json-file creating an apple pass file tutorial]. | ||
| + | * [https://github.com/keefmoon/Passbook-Example-Code/blob/029e97b0dae29dee86bd4bafccc6639a71d8cd4c/Pass-Example-Generic/Pass-Example-Generic.pkpass generic pass example (zip)]. | ||
| + | * [https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/YourFirst.html building your first pass on the apple developer network]. | ||
| + | * [https://developer.apple.com/services-account/download?path=/iOS/Wallet_Support_Materials/WalletCompanionFiles.zip Pass Tutorial Companion Files (Auth required)]. | ||
[[Category:Apple]] | [[Category:Apple]] | ||
[[Category:iOS]] | [[Category:iOS]] | ||
[[Category:ZIP based file formats]] | [[Category:ZIP based file formats]] | ||
| + | [[Category:JSON based file formats]] | ||
Latest revision as of 13:16, 18 April 2025
PKPass is the format of tickets, coupons, and loyalty cards used in the iOS Passbook app (and other apps designed to use the format). It is a ZIP-format archive (but using the .pkpass extension instead of .zip) containing JSON-format data along with some PNG-format images. The files within the archive have specific expected names to denote their function.
[edit] pass.json Structure
The pass.json structure is described here and supported with reference files.
The following fields are described as being required:
-
passTypeIdentifier -
serialNumber -
formatVersion -
teamIdentifier -
organizationName -
description
[edit] Links
- Pass file format
- Package structure (gives filenames to be used)
- PKPass class reference
- PassWallet for Android
