How to Integrate#

This section covers the basics of how to integrate. Click these links below to access each section of the integration process as required, or simply scroll down the page:

• Integration prerequisites
• What do you need to develop to complete the integration?
• Token management & access
• Accessing Production Endpoints

Integration prerequisites#

To be eligible for this integration, you must have the following:

• API Development Capability – The ability to develop an API in-house or access third-party support for API development

To integrate with our Partner API, you also must be one of our partners and ensure that you have:

• Access to Partner Portal (our self-service portal for partners)
  • Click here for more information on what’s Partner Portal
• Access to the Integrations Plugin in Partner Portal
  • Click here for more information on how to access the Shops Integrations Plugin
• One or more active product(s) on Catalog (to enable promotions to be raised on these products)

What do you need to develop to complete the integration?#

At the high level, there are two things you need to do:

1. Set Up a Webhook to receive Order Events#

   • Step 1: Develop a webhook to receive live order events.
   • Step 2: Ensure the webhook is ready to receive updates for any modifications during the lifecycle of the promotion

2. Integrate with REST API Endpoints#

   • Step 1: Use the PUT endpoint to create promotion jobs
   • Step 2: Use the GET endpoint to retrieve status information for the promotion

Token Management & Access#

What is a token & how do I use it?#

A Bearer API token is a way to prove who you are when making API requests. It’s part of the OAuth 2.0 standard and is included in the request headers to show that you’re allowed to access certain data or services.

How It Works#

• Get the Token – using the Shops Integrations Plugin
• Use the Token – Every time you make an API request, you include the token in the header

Why It’s Useful#

• No need for usernames and passwords in every request
• The server doesn’t have to remember who you are (it just checks the token)

What do I need to access it?#

Only users with access to the Shops Integrations Plugin in Partner Portal can generate the bearer API token from token management in the settings section

Steps for Authentication & API Access#

1. Generate an API Token

   • Step 1: Go to Partner Portal > Shop Integrations.
   • Step 2: Go to Settings > API > Token Management section, input a name based on your use case.
   • Step 3: Generate a Bearer token. You can create up to 11 tokens, and they have no expiry.

2. Secure Your Tokens

Ensure tokens are securely stored and not shared with support teams

Here’s how to generate your token:

Important things to remember about API tokens#

• When you create a token, they never expire! Please secure and keep track of your API tokens, and never share them with other people, even our support team
• Each API token should be assigned a specific name corresponding to its intended use case i.e: Catalog Management, Order Management, Promotion Management
• Up to 11 tokens can be created at one time
• Tokens are valid for all stores under your chain
• Since tokens are managed via the Shops Integrations Plugin, it’s advisable to limit the access to that plugin to the people in your organisation who absolutely need it.
• In order to access Partner Portal or Shops Integrations, please reach out to your account manager

Where can I find the production API endpoints?#

Further information is detailed in the partner API documentation here.