Alpha API Documentation

Reward Store API Documentation

The Reward Store API Documentation is a reference guide on using the Reward Store API for both full reward stores and API only stores.

What is this API

The Reward Store API is a RESTful API allowing you to manage aspects such as products and recipients. JSON is used as the content format.

Full reward store? API only store?

A full reward store is a store hosted on our reward store platform, whereas an API only stores are hosted elsewhere only using the API for product information. Not all endpoints are available for API only stores.

How do I use this API? Which platforms support this API?

This API is platform and language neutral. As long as you can send and receive HTTP requests and encode/decode JSON, you can use this API.

However, it is strongly recommended to use a HTTP library for your programming language of choice. For PHP applications, we recommend using Guzzle.

For testing the API, you can use an application such as Postman or Insomnia.

Security warning

The API key you are provided must be kept private and not exposed to end users.

Therefore, this API must not be consumed client side, it must be done server side.