API

Harness the power of the Flexito OmniAI API to seamlessly manage and interact with your data flows. Whether you're retrieving subscriber information, managing e-commerce data, or configuring flow tags, this guide will walk you through the essential steps to effectively use the API.

Explore the Checkout API details in the Swagger API Documentation here: .

Understanding APIs

The Flexito OmniAI API allows you to access and manage data from your custom-built flows. Below are some capabilities of the Flexito OmniAI API.

• Retrieve the flow you have created in Flexito OmniAI.

• Manage data operations such as creating, deleting, or accessing flow tags and fields.

• Handle subscriber data, including retrieving subscriber details, modifying their tags or fields, and managing subflows sent to them.

• Configure e-commerce data like carts and products.

If you need to work with the data mentioned above, the following sections will guide you on how to use the Flexito OmniAI API.

Authorization

To ensure data security, the API requires you to verify your identity with specific attributes. Your first step is to enter the authorization details by clicking the Authorize button, as shown in the image below.

Next, fill in the three required attributes in the text box.

The following section explains how to locate these attributes.

Creating an API Key (http, Bearer)

Step 1: Log into your Flexito OmniAI account. Click on your account name and avatar in the top right corner, then select 'Your Settings' from the dropdown menu.

Step 2: Navigate to the API Keys section by clicking the corresponding button in User Settings. Enter a name for your key and click 'Create'.

Step 3: Your key will appear in a pop-up window.

WARNING: This is your new API Key. It will only be shown this one time, so make sure not to lose it! You can revoke the key anytime from your API settings.

After closing the window, you'll have the basic information about the key, except for its value.

Obtaining the Curl and Request URL

Curl is essential for making API requests. Before obtaining the curl in the Flexito OmniAI API documentation, some preliminary steps are required.

Let's use 'Get Flow Tag' as an example.

Step 1: Expand the operation category, in this case, the Flow Tag. Locate the action and feature, Get /flow/tags. Click the row to reveal a dropdown page as shown below.

Step 2: The logo indicates authorization. If you've already completed this step, you can skip it. Otherwise, follow the instructions in the Authorize section ().

Step 3: Click 'Try it out.' You'll then be able to input parameters or the request body, and the Execute button will appear at the bottom.

Step 4: Enter the required parameters or request body, and click the Execute button. You will then receive the Curl and Request URL.

TIP: Use the Clear button to reset the parameters if needed.

API Responses

This section displays the JSON result you receive from the Flexito OmniAI API. A code of 200 indicates a successful response, while a code of 400 signifies an error.

Example Values and Schema

Besides example values, you can click on "Schema" to see more details, such as which values are mandatory.

Flexito OmniAI Official API Find more information about the Flexito OmniAI API here: .

Flexito OmniAI Partner API

If you're part of the Flexito OmniAI partner programme, you can learn more about the Partner API here: .