Skip to main content

API Integration Guide

This is the technical step-by-step guide to implementing an integration that directly uses our API and frontend SDK.

Before you get here​

Before beginning integration, your Customer Success Manager and Solutions Engineer will have taken you through two kick off meetings:

  • the project kick-off meeting
  • the technical integration kick-off meeting.

Now for the integration process​

We will then launch the technical integration process. This is where this guide comes in.

After setting up your Sandbox account, there are three steps to the implementation:

You will run through these 3 tech touchpoints with your Solutions Engineer - one meeting per step.

The final step is end-to-end testing. We have a set of manual tests to run to check your integration works.

Once the tests are complete, you're good to go!

Read the test cases before starting

We recommend that you read the testing checklist before you begin the work, as this will make clear what needs to be in place at the end of the integration work.

You may also wish to read through the guide before starting, to familiarise yourself with the steps in the flow.