Integrate APIs

Add an API

In the Action tab, open API and click Add configuration.

Select operation type

This step determines how the API is used:

• Query: Use the API as a data source for components (List, Page, etc.)
• Mutation: Use the API as an action

This example selects Query to use the API as a List data source.

Set request format

Momen supports two ways to configure request format:

• Auto-parse (recommended): After a successful test request, the system parses the format automatically.
• Manual configuration: Fill in all parameters yourself.

Auto-parse workflow:

1. Open debug mode.

   

2. Fill in method, domain, path, body, etc., then click Send.

   

3. After a successful send, click Advanced and verify the format.

   

4. Confirm Request parameters and Response parameters in order. When updating an existing configuration, merge old and new parameters.

   

5. After confirmation, you have a standard API request and response format.

   

Special field formats and mapping

1. External image fields

When a third-party API returns image URLs or Base64-encoded image data, convert them to Momen-compatible image format by setting the field encoding to:

• URL_MEDIA_ENCODE (for image URLs)
• BASE64_MEDIA_ENCODE (for Base64 data)

The system downloads images from URLs or parses Base64 data, uploads them to object storage, and converts them to Momen image format.

2. JSON string fields

Sometimes a field value is an escaped JSON string rather than a JSON object. For example, in the structure below, avatar is a string instead of an object:

{
    "data": {
        "name": "won",
        "utime": "2025-06-16 11:15:59",
        "avatar": "[{\"file_id\":\"4f397aff-854a-4a6a-b0e9-bc727c6f7f0a\",\"thumbnail_path\":\"https://example.com/thumb.jpeg\"}]"
    }
}

Set the field encoding to JSON_STRING_ENCODE and the system will parse it as a JSON object.

Use API as a data source

In List, Select View, and Page data source settings, select an API configured as a Query type.

Specify which response field is the list and which input parameters are required.

Use API as an action

If you configured a Mutation type API, find it under the Request category in the action list.

• Configure parameters: API input parameters
• Output parameters: On success, response data is available in result data