The Uniqodo suite of RESTful APIs enables developers to build integrations into any eCommerce platform for delivering value-focused promotions for their business. These APIs have been built to communicate the use cases that developers are tasked to implement by marketing teams, providing a seamless transition from business requirements to technical implementation.

Technical Onboarding

Below are the key steps required to begin working with our APIs.

1. Get your API key

Login to Uniqodo to access your API key from Settings > Integration. You will find your API key on that page.

2. Decide the required data for your use cases

Understand the business use cases from your marketing team including the data points required for promotions. In addition to the small amount of data you need to map as standard, you may need to add additional data (such as extra product and customer attributes) that are unique to your business - we call these attributes. We also recommend uploading your product catalogue to enable product-level promotions and rewards.

3. Integrate the necessary endpoints depending on your use cases

You do not need to integrate all the available endpoints in every API. The endpoint you integrate depends on your use cases. See the section on Typical Use Case below as a guide.

4. Set up a promotion

Set up a promotion with the reward type that meets your use case.

5. Test the integration

You can now begin making requests to the relevant endpoints to test the different use cases that you've implemented.

Typical Use Case

There are different endpoints to integrate with Uniqodo depending on your use case. Here are the typical use cases and corresponding integration points:

1. Promotion distribution: present a promotion to customers by issuing a unique code through the code claim endpoint or by showing customers the applicable promotions they qualify for using the applicable endpoint.

2. Reward application:
   1. Coupon Promotions: when customers apply coupon codes to their orders, validate the codes against the promotion criteria and apply the appropriate reward if the code is valid.
   2. Automatic Promotions: qualify a customer's order for any applicable promotions and automatically apply the associated rewards if they qualify.

3. Order completion: in all cases, make a call to the transaction endpoint whenever a customer completes their purchase. This allows Uniqodo to:
   1. Record promotion and coupon code redemptions
   2. Award loyalty points
   3. Record the transaction to a referral campaign
   4. Enforce promotion limits and fraud rules
   5. Activate other promotions based on purchase activity

These operations ensure a robust and seamless end-to-end promotion activation and redemption process.