About the Passcreator 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 that is available at www.passcreator.com. The API provides functions to create, read, update and delete Passbook passes. Additionally there are functions to get a list of pass-templates and existing passes. In order to use the API features a pass-template must be created using the Passcreator online app. Creating and updating pass-templates is currently not supported via the API. 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 e-mail to firstname.lastname@example.org. Also this document might be subject to change as we are constantly adding new features to Passcreator. If you want to get notified about changes to the API please also write us an EMail to email@example.com and we’ll add you to a recipient list that is notified as soon as a new version of the documentation is available.
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. To get the API key log in to Passcreator (https://app.passcreator.com/login) and go to „Account Options“. You can find the API key at the bottom of the page.
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 (http://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. Also the API functions will return information about the executed steps like IDs of created passes or error messages as JSON arrays.
In general the Passcreator API will always return the appropriate HTTP-statuses e.g.:
- 200 - Request was valid and the results are being returned.
- 201 - Created - the action you wanted to execute was successful and the information about the created object is returned.
- 204 - No Content
- 400 - an error occurred and the request could therefore not be processed. Details about the error is specified in the response.
- 401 - Unauthorized - you have specified an invalid or no Authorization header.
- 404 - Not found - the given UID could not be found or is invalid.