The API is a REST API using JSON to exchange data. You will be provided the base URL as well as an API key to use.
You will need to set the following HTTP headers as follows:
| Accept | application/json |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR_API_KEY_HERE |
If your API key is incorrect, you will get a 401 Unauthorized response.
Along with your API key, you will be provided with a base URL in the format of:
The URL to interact with the API is {base url}/api/v1/{endpoint}.
For example: https://xxxxxx.reward-store.co.uk/api/v1/recipients/
The endpoint URL to use is detailed on each of the endpoint pages.
The GET POST PUT and DELETE methods are used in this API.
If your HTTP library does not support methods other than GET and POST, use the POST method and specify the method in a _method POST field.
However, you may wish to instead use a more capable HTTP library.
Output from the API is in JSON format. Always use a JSON parser to process it, do not attempt to manually process the output.
Various endpoints have an option to specify a language for some fields, for example the name field for Products and Categories.
The following language options are available:
Depending on how your store is set up, product queries may return a currency field.
The following currencies are available: