Client APIs

# Introduction

The UNIQREWARDS Client API enables our business clients to issue new UNIQGIFT digital vouchers (opens new window) through system integration.

In addition to voucher issuance, the API provides features to retrieve the status of vouchers and obtain the available catalogue of products.

It's a REST API (opens new window) that follows industry standards and a data-oriented design. It uses JSON (opens new window) for the messages format.

See also the glossary for definitions of the the key terms used in this documentation.

# Getting started

We recommend starting with the integration process, which begins by exploring the API's features in our DEMO environment and progresses to a full integration in our UAT environment. Once UAT (User Acceptance Testing) requirements are completed, production credentials and configuration will be provided.

For each environment, we will provide a pair of credentials to access the API's secured resources. The credentials are used to obtain an auth token. The token is used in turn to access the API resources. See authentication and authorization on how to obtain and use the auth token.

The catalogue of products that can be issued is available using the retrieve catalogue endpoint of the API.

A Postman collection (opens new window), containing sample requests for each feature, is provided to facilitate your API integration.

# Features summary

The API provides features for issuing and managing digital vouchers, each accessible through a unique API endpoint. Detailed documentation for each feature is available via the links below:

  • Retrieve catalogue of products: Obtain the catalogue of products that can be issued. Can be used to obtain the list of products to be displayed in a user interface.
  • Retrieve product details: Obtain the details of a single product. Can be used to get the needed data for a product details page.
  • Issue vouchers: Issue one or more vouchers of a chosen product. This is the central feature of the client API.
  • Retrieve vouchers information: Obtain information about vouchers, including their status, expiration date, and remaining balance. Can be used to provide updated voucher information to the end users for their issued vouchers.

# Environments

In addition to our PRODUCTION, we provide DEMO and UAT environments as part of our integration process support.

  • DEMO environment:
    • api.demo.uniqrewards.com/v3
    • Used for the initial discovery of the API.
    • We maintain this environment with the production version of uniqrewards.com/v3.
    • Set of products and credentials isolated from PRODUCTION.
  • UAT environment:
    • api.uat.uniqrewards.com/v3
    • Used during the project integration phase. Testing of the integration is to be completed on this environment.
    • Set of products and credentials isolated from PRODUCTION.
  • PRODUCTION environment:
    • api.uniqrewards.com/v3

See as well the auth service resources for the corresponding resources to use for authentication.

# Other resources

In addition to this guided documentation, the following resources are available to assist you in interacting with the API:

# Getting help

In case of issues integrating with the UNIQREWARDS Client API, please contact UNIQREWARDS API Support.

To assist us in investigating errors, please provide the following context with your email:

  • The environment where the issue or error occurred
  • The date and time of the error
  • The request information, including path and parameters
  • The error response, including the request ID and the error code

Glossary of terms →