Introduction

Version

The Client API v2 has been replaced by the Client API v3. We recommend that new integrations use version 3 to take advantage of the latest features and improvements.

For clients already integrated with version 2, migration to version 3 can be considered. While we will continue to support version 2, transitioning ensures access to the most up-to-date capabilities.

The UNIQREWARDS Client API provides endpoints to issue new vouchers and check the status of existing ones.

Only clients (as opposed to merchants) interactions are available from this API.

Functionalities

• Authentication and Authorization: How to obtain an authorization token necessary to make subsequent API calls?
• Request Vouchers: Issue one or more vouchers.
• Check Vouchers:
  • Check the status of one or more vouchers (are they used, expired or trashed?).
  • Check the expiration date of one or more voucher.
  • Check the remaining balance of an existing voucher.

Resources

Environments

In addition to our Production, we provide environments for DEMO and UAT on which API requests can be tried and tested.

• DEMO environment:
  • api.demo.uniqrewards.com/v2
  • We maintain this environment with the PROD version of uniqrewards.com/v2.
  • Set of products and credentials isolated from PROD.
• UAT environment:
  • api.uat.uniqrewards.com/v2
  • To be used during the project phase.
  • Set of products and credentials isolated from PROD.
• PROD environment:
  • api.uniqrewards.com/v2

See as well Integration process and UAT.

Postman Collection

A Postman collection (opens new window) is available to get you started with the UNIQREWARDS Client API.