PassKit
PassKit: Create, Distribute and Manage Apple Passbook Passes. PassKit is a set of tool and methods that allow businesses and developers quickly, easily and affordably design, create, distribute, update, analyse and manage content for Apple Passbook. PassKit helps you and your business at every step of the Passbook Pass Lifecycle. API to access PassKit. 1. Create passkit API account; 2. Goto:…
225 subscribers
19 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
PassKit endpoints
| Method | Endpoint | Description |
|---|---|---|
| Image methods | ||
| GET |
Get Image Data /image/{imageID} |
This method returns data about a particular imageID, specifically te useage types that it has been processed for. More info at: https://code.google.com/p/passkit/wiki/GetImageData |
| POST |
Upload Image /image/add/{imageType} |
This method allows you to upload images for use with other methods such as template methods and pass methods. More info at: https://code.google.com/p/passkit/wiki/UploadImage |
| GET |
Upload Image (by URL) /image/add/{imageType}/ |
Same as Upload Image method, only instead of uploading image, you can use an image URL. |
| Pass methods | ||
| GET |
Get Unique Pass Id (by share id) /pass/shareid/{shareID} |
|
| POST |
Invalidate Pass (by pass id) /pass/invalidate/passid/{passId} |
|
| GET |
Get Pass Details (by template and serial) /pass/get/template/{templateName}/serial/{serialNumber} |
|
| POST |
Invalidate Pass (by template name and serial) /pass/invalidate/template/{templateName}/serial/{serialNumber} |
|
| PUT |
Update Pass (by template name & serial) /pass/update/template/{templateName}/serial/{serialNumber}/{push} |
This method is used for updating a pass by template name & serial. It accepts the parameters returned by the Get Template Field Names method, plus relevance fields for date and… |
| PUT |
Update pass (by pass id) /pass/update/passid/{passID}/{push} |
This method is used for updating a pass by pass id. It accepts the parameters returned by the Get Template Field Names method, plus relevance fields for date and for up to 10… |
| GET |
Get Pass Details (by pass id) /pass/get/passid/{passid} |
Retrieves the pass details by Pass ID |
| PUT |
Issue Pass (Batch) /pass/issue/batch/template/{templateName} |
This method is used for creating batches of up to 100 passes. More info at: https://code.google.com/p/passkit/wiki/BatchIssuePass |
| PUT |
Issue Pass /pass/issue/template/{templateName} |
This method is used for creating passes. If all fields are fixed, or not updatable by the user, then it is not necessary to post any JSON, otherwise requires a data dictionary… |
| Template methods | ||
| GET |
List Templates /template/list |
This method returns all the templates for the user account (API key & secret). More info at: https://code.google.com/p/passkit/wiki/ListTemplates |
| GET |
Get Template Field Names (full) /template/{templateName}/fieldnames/full |
This method returns the full field names that can be used with the Issue Pass and Update Pass methods for a particular template. More info:… |
| GET |
Get Template Field Names /template/{templateName}/fieldnames |
This method returns the field names that can be used with the Issue Pass and Update Pass methods for a particular template. More info:… |
| POST |
Reset Template /template/{templateName}/reset/push |
This method resets each pass record to the default values. This only affects values that the user cannot edit. The method also removes all data-fields from each pass record. More… |
| GET |
Get Passes For Template /template/{templateName}/passes |
This method returns some basic template information and all the passes for the template (pass meta -and field data). More information at:… |
| PUT |
Update Template /template/update/{templateName}/{push} |
This method allows for static fields of default values of dynamic fields of templates to be changed (and potentially pushed) to all passes. More info at:… |
| Admin methods | ||
| GET |
Authenticate /authenticate |
Authenticates access to the API. IMPORTANT: You will need to pair your PassKit API Key and Secret with your Mashape username BEFORE you can use this or any other method via… |
PassKit pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
