Passcreator API Documentation
Welcome to the Passcreator API documentation. This guide will help you integrate with our RESTful API to manage wallet passes programmatically.
Looking for the regular knowledge base and help content?
About the API
This documentation describes the RESTful API that can be used if you or one of your customers has a valid account for the online app. The API provides functions to:
- Create, read, update and delete wallet passes
- Manage pass templates: create, list, read, update, delete
- Bundle multiple passes together
- Send push notifications to passes
- Validate passes via app configurations and scans
- Filter passes using advanced query language to target specific subsets (e.g., search passes or bulk update multiple passes)
- Retrieve statistics about pass usage
- Deliver passes via email
- Configure webhooks for real-time event notifications
In order to use all API features for wallet passes, a pass-template must be created. While pass templates can be created via the API (see Create a New Template), we recommend creating your first template using the Passcreator online app to familiarize yourself with the available options and structure.
This documentation is provided as is without any warranty. If you notice that any of the functions or methods don't work as expected or find something that is not described clearly enough please send us an email to support@passcreator.com.
This document might be subject to change as we are constantly adding new features to Passcreator. When applying changes or adding new features we'll make sure to not remove any fields from responses but you should build your integration in a way that it can handle additional fields that may be added in the future.
Obtaining an API Key
The API key must be submitted in the HTTP Authorization header on every request. It is used to check if the caller is authorized to execute the function.
For detailed information on how to obtain and use an API key, see the Authentication documentation.
Testing
If you want to test the API or learn how it works a good way to get used to it without having to code much is installing a browser plugin like Postman (https://www.getpostman.com/) for Google Chrome. It allows you to test all Passcreator API functions so you can get an idea of how it works.
If API functions need complex data this data must be submitted as JSON payload.
Make sure to set the Content-Type header to application/json when sending a request body.
Also the API functions will return information about the executed steps like IDs of created passes or error messages as JSON arrays.
HTTP Status Codes
In general the Passcreator API will always return the appropriate HTTP-statuses:
- Name
200- Type
- OK
- (mandatory)
- Description
Request was valid and the results are being returned.
- Name
201- Type
- Created
- (mandatory)
- Description
The action you wanted to execute was successful and the information about the created object is returned.
- Name
204- Type
- No Content
- (mandatory)
- Description
The request was successful but there is no content to return.
- Name
400- Type
- Bad Request
- (mandatory)
- Description
An error occurred and the request could therefore not be processed. Details about the error is specified in the response.
- Name
401- Type
- Unauthorized
- (mandatory)
- Description
You have specified an invalid or no Authorization header.
- Name
404- Type
- Not Found
- (mandatory)
- Description
The given UID could not be found or is invalid.