Integration process and UAT

Version

This page is for the Client API v2. For the Client API v3 documentation, please see the integration process page.

To ensure a quality integration to our clients, we follow the below process:

Exploration of features using the DEMO environment.

DEMO allows clients to complete the evaluation of the API features and how the vouchers issued will integrate in the user flow.

Note

Please contact UNIQREWARDS API Support to access the DEMO credentials and the catalogue of products to issue.

The DEMO catalogue includes all types of products we offer: gift cards (super voucher), fix and dynamic value-based vouchers, product-based and third-party vouchers.

Integration with the API and user acceptance tests

Clients integration developments should be initiated using the UAT environment.

At this step, dedicated credentials and a dedicated catalogue of products will be provided.

Note

A first selection of products to include in the UAT catalogue is expected to move to this step. This can be discussed with UNIQGIFT Corporate

The UAT catalogue may be identical or a subset of the expected Production catalogue.

The following tests form the basis of UAT for an integration with our Client API:

Issuance of all products in the UAT catalogue

Please ensure specifically that dynamic value-based products are supported. This represents the majority of our products.

You may refer to the Issue Dynamic Products documentation page on how to support dynamic value-based products.

Obtain voucher status using Check Vouchers

Depending on the use-case, this endpoint may or may not be integrated in the issuance flow.

Check Vouchers may also be used for support and investigation to obtain status and usage.

Please refer to the dedicated documentation page on how to request vouchers statuses.

Implementation of issue recovery using idempotency

Warning

All voucher issuances performed in Production will be invoiced.

To avoid discrepancies with our records of voucher issuances, we require all clients to implement issue recovery using the idempotency feature of the API.

Please refer to the dedicated documentation page issue recovery using idempotency.

Go-Live and Production

Requirements

Clients are expected to complete UAT including the above mentioned issuance of dynamic value-based products and implementation of recovery using idempotency before moving to Production.

After completion of UAT, the Production credentials and catalogue will be provided.

You may issue vouchers in Production as soon as you have the Production credentials 🎉