Connect external systems

Introduction

Typically, the graphical interface is presented to the end customer in the form of a pedagogical and streamlined guide (known as an Assistant in the platform). The guide helps make it as easy as possible for the user to go through the connection of external systems and the configuration of the customer account.

The guide mainly consists of three parts:

• Overview: On the left, the steps that need to be completed, those that are finished, and the current step in the process are displayed.
• Settings: The middle section constitutes the main area where the actions required for the current step in the process are performed.
• Help: A help section provides more detailed explanations for the page the user is currently on.

Connection guide

Below is an example of how the guide might look at a given step in the process. The basic structure remains the same regardless of which system combination is being set up, with the pages and number of steps varying depending on the specific configuration of the customer account.

Connection types

The exact procedure for connecting varies depending on the external system. Where possible, the platform primarily uses an OAuth2-based flow, which means that the user is redirected in their browser to the external system where they log in and approve the connection, before returning to the guide to continue.

This method is recommended as it is the simplest for the user to complete the process, but unfortunately, not all systems support this approach, and in those cases, the procedure may differ slightly. Regardless of the method used, the help section on the right will provide instructions on how to proceed.