External API

Working with External APIs in eMOBIQ AI

eMOBIQ AI enables seamless integration with external APIs, allowing your application to communicate with third-party systems, databases, or services. This functionality empowers developers and system integrators to extend the capabilities of their applications by connecting to external data sources and executing custom logic.

1. Creating a New API Connection

Let's begin integrating an external API into your eMOBIQ AI environment:

Step-by-Step Instructions:

1. Add a New API

   • Select External API as the backend connection

1. Adding a new API

   • Click on + Add a new API

   • Provide a meaningful name and description for the API connection. These will help identify the purpose and function of the API within your application

   • Click Save to proceed

1. Configure Domain Settings

   • Click on + Add Domain

   • Enter the Base URL (also known as the root endpoint) that links eMOBIQ AI to the target external API

2. Authentication Setup

Authentication ensures secure access to external APIs. eMOBIQ AI supports five common authentication methods:

1

Selecting Authentication Type

Select the appropriate authentication type based on the external API's requirements

Supported Authentication Types:

1. Basic Auth

2. API Key

3. Bearer Token

4. JWT Bearer

5. OAuth 2.0

2

Authentication Credentials

Depending on the type of authentication your API requires, you’ll need to provide the appropriate credentials. Here’s what to enter for each authentication type:

Basic Auth

API Key

Bearer Token

JWT Bearer

OAuth 2.0

• Enter your Username and Password

• The system will automatically encode these into a Base64 string and include it in the request headers

• Specify the Header Name (e.g., x-api-key) and the Key Value

• This adds a static key-value pair to the request headers and is commonly used for lightweight service authentication

• Enter the Token string that will be used as the Bearer credential

• This token is typically obtained from an authentication server and will be included in the Authorization header like this: Bearer <your_token>

• Enter the JWT (JSON Web Token) you want to use for authentication

• The JWT is usually generated by an identity provider or authentication service and must be valid at the time of the request

• Some systems also allow you to generate or refresh tokens dynamically using pre-request scripts or custom logic

• Client ID: The public identifier for your application

• Client Secret: The private key used to authenticate your app (optional depending on the grant type)

• Token Endpoint: The URL where the system can request an access token

• You may also select the appropriate Grant Type (e.g., Authorization Code, Client Credentials) and configure additional settings if needed

• Ensure to refresh your access tokens when required:

3

Authentication Instructions

After configuring your API authentication method, you can define Authentication Instructions — this tells the AI how to use the credentials when generating the app. This effectively creates a more accurate end result and helps to save cost during the app generation process.

Auth Instructions allows you to:

• Specify how authentication should be applied in requests (e.g., which headers, tokens, or query params to include)

• Customise the behaviour of each API depending on the level of control you need

• Help the AI correctly authorise requests to secured endpoints, without manual adjustments

• While this step is optional, providing clear authentication instructions improves reliability and reduces ambiguity in how the AI should structure API calls

3. Defining API Functions

Once the domain and authentication are configured, you can define specific functions (or endpoints) to interact with the external API

Create a New Function:

1. Function Details

Method

Name

Path

Supported HTTP methods include GET, POST, PUT, PATCH, and DELETE

A descriptive name for the function

The relative path of the API endpoint (e.g., /api/v1/users)

1. Request Configuration

Params

Headers

Body

Instructions

Query parameters appended to the URL

Metadata sent with the request (e.g., content type, authorization headers)

Data sent in the body of the request, particularly useful for POST, PUT, and PATCH methods

Describe how the AI should interpret and utilize this function. Think of this as a functional specification for the AI engine to understand how to execute or reference this API during runtime

4. Testing the API

Before integrating the API into your application, it’s essential to verify that it works correctly

1

Test

Use the Test button to send a request to the external API

2

Return Message

A successful test will return a 200 or 201 status code, indicating that the connection and function execution was successful. Otherwise, try resolving the errors that appear

3

Examination

Examine the returned data to ensure it matches expectations and contains the necessary fields for downstream processing

5. Refining the API Response

Sometimes, not all data returned by an API is required by your application. You can refine the response to improve performance and clarity.

(1) Edit or Remove Unnecessary Fields

(2) Map the Response

If certain fields aren’t used, click Edit to remove them to ensure the AI doesn't use it, this is essential in helping the project be generated quicker and ensuring that only usable API information is available when creating the app

• Use the Map Response feature to filter or transform the JSON structure returned by the API

• Select or deselect via the checkboxes

• This helps simplify complex responses and align them with the format expected by your frontend components or internal logic

6. Importing APIs Using Schemas

For larger or more structured integrations, eMOBIQ AI supports importing API definitions using schema files

(1) Import via Schema File

(2) Manual Schema Entry

Upload a schema file (such as OpenAPI 3.0 Schema) that describes the API endpoints and data structures

• Fill out the schema form manually to define the API structure directly in the platform and click generate

• Functions will be populated according to the schema

• This approach is ideal for APIs that don't provide downloadable schema files but still need formal documentation

Conclusion

By leveraging the robust API management features of eMOBIQ AI, you can securely and efficiently integrate external services into your applications. Whether you're retrieving data, submitting forms, or triggering backend processes, eMOBIQ AI provides a flexible and scalable framework for building intelligent, connected systems.