API compatibility
This API will evolve over time when access to other data within the system is made available. The plugin architecture will also be integrated to enable access to specific functionality within say the rewards plugin. However, none of the current endpoints or response values will change. You can write your integration code knowing that it will now be affected by future updates.
SSL/HTTPS recommended
We recommend SSL is used for all requests. You can require SSL by forcing it via your web server.
UTF-8 encoding
Every string passed to and from the API needs to be UTF-8 encoded.
HTTP Method
All methods are done using POST unless otherwise stated.
Date format
All date/times in the API are strings in the following format:
Y-m-d H:i:s
For example:
2021-02-05 08:29:07