API Manager

The API Manager allows you to add, edit, manage, and store any number of system APIs.

To create a new API, click on "Add New API" from the API Manager page. Configuration options, including parameters and other details, will appear on the right side of the screen. For Private systems, you can make modifications/deletions to APIs only in Draft mode.

System Types and API Permissions

Private Systems:

• APIs can be added or edited only by system builders when the system is in draft mode.

Public Systems:

• Users can add, edit, or delete private APIs.

• Public APIs cannot be modified directly.

If users need to make changes to a public API, "Create as Private API" option can be used. This allows you to duplicate the public API and create a private version, which can then be modified as required.

For such duplicated APIs, a separate Save button is available. Use this button to store the modified changes to the private version.

Filtering Options

The API list supports filtering by:

• Type: All / Private / Public

• Method: All / GET / POST / PATCH / PUT / DELETE

Save All and Delete Options

Next to the "Add New API" button, you’ll find three actions:

• Save All: Save multiple APIs at once with a single click.

• Delete: Select and delete one or more private APIs. Public APIs cannot be deleted.

Creating an API

When adding a new API:

• Provide a meaningful unique name (e.g., Get Customers , Create Order ).

• Specify the request method, URL, headers, parameters, and body.

• Make sure to upload the sample request and response data for mapping purposes.

• During execution, System Credentials are automatically applied to all APIs. If you want to exclude credentials for a specific API, enable the “Skip Auth” option in the Others tab.

• The default API timeout during execution is 240 seconds. You can modify this value in the Others tab of the API settings.

• Credential Inputs ({{inputs.keyname}}) Use these to insert values from the selected system credentials into the API's URL, headers, params, or body. Example: {{inputs.album}} fetches the album value defined in the credentials.

• Token Values ({{token.keyname}}) Use these to include dynamic tokens (e.g., access tokens) generated during execution based on system auth type. Example: Authorization: Bearer {{token.access_token}}

Cloning and Deleting your APIs

You can manage an API by clicking the three-dot menu next to it. You'll see two options:

• Clone: This allows you to clone the selected API. The cloned API will have '-CLONED' appended to its name.

Cloning is only available for private APIs, you cannot clone public APIs. However, you can use the 'Create as Private API' option to replicate a public API as a private one.

• Delete: This lets you flag APIs for deletion. You can switch between APIs and flag the ones you want to delete. Once done, click Save — the flagged APIs will then be permanently deleted.

API Common Fields

The API Manager also supports configuration of common headers and parameters through the API Common Fields section. These fields provide a centralized way to define shared headers and parameters across all APIs.

• Any headers or parameters defined here are automatically populated in all APIs, including the Test API.

• Even if the common fields are not explicitly saved, they are dynamically applied during usage in draft mode for testing purposes. Make sure to click save to save the changes.

While creating a new system, the Content-Type: application/json header is added by default in the Headers section. You can edit or delete this header at any time in the Common Fields section under API Manager.

API Testing in API Manager

You can test the API you're developing directly within API Manager. Click the “Test” button located on the right side of the Request URL section, or go to the “Test Details” tab in the API sidebar. This will open the Test Area on the same page, where you can either:

• Select an existing credential. (or)

• Manually enter credentials to test the API.

When testing APIs that include variables in the URL or parameters, the system now prompts users to enter values for those variables.

1. Once configured, click the “Test” button to trigger the API call.

2. Provide values for the required variables.

3. Select or enter credentials.

4. Proceed with testing as usual.

This ensures accurate population of variable values during test execution. The test results will be displayed below, including: Body, Request Headers and Response Headers.