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.boostcommerce.com.au. The API provides functions to create, read, update and delete Wallet 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 Pass2Wallet online app here https://wallet.boostcommerce.com.au/en/login.
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 support@boostcommerce.com.au. Also, this document might be subject to change as we are constantly adding new features to Pass2Wallet. 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. To get the API key log in to Pass2Wallet https://wallet.boostcommerce.com.au/en/login and go to Integrations –> API Keys and create a new API Key.
Content Type
Make sure to set the Content-Type header to application/json for all endpoints!
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 (http://www.getpostman.com/) for Google Chrome. It allows you to test all Pass2Wallet 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 Pass2Wallet 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.