API Connector

The API connector enables data retrieval from REST APIs with flexible configuration options.

API Connection

Configuration Parameters

• Source Name – Unique identifier for the API connection.

• Request Type – HTTP method (GET, POST, PUT, DELETE).

• URL – API endpoint address.

• Parameters – Query parameters as key-value pairs.

• Headers – Request metadata (authentication, content type, etc.).

• Body – Request payload for POST/PUT operations (JSON format).

• Pre-requisite – Dependent API calls that must execute first.

• Send – Executes the configured request.

• Extract Data – Parses response using JSONPath or other extractors.

Step-by-Step Configuration

Step 1: Select API as Source Connection

1. Navigate to Start Job.

2. Select API under Source Connection Type.

3. Enter a unique Source Name (e.g., API1).

4. Click ✅ to confirm.

API Source Selection

Step 2: Configure API Request

1. Enter the API Endpoint URL.

2. Select the appropriate Request Type.

3. Add Parameters (key-value pairs) if required.

4. Provide Headers for authentication or content type.

5. Include JSON Body for POST/PUT requests.

6. Configure Pre-requisite APIs if needed.

API Configuration

Configuring Pre-requisite APIs

Pre-requisite APIs are essential when the main API requires tokens or credentials with limited validity (e.g., access tokens, session keys).

Use Cases

• Token Management – Refresh expired authorization tokens.

• Dynamic Authentication – Generate new tokens when current ones expire.

Configuration Steps

1. Extract Value Path – Specify JSONPath to extract values (e.g., $.body["access_token"]).

2. Variable Mapping – Assign a variable name to the extracted value.

3. Usage in Main API – Reference variables using #variable_name# syntax (e.g., Authorization: Bearer #access_token#).

Support Levels: Configure up to 2 levels of pre-requisite APIs. All extracted values are available for use in the main API call.

Pre-requisite API

Navigation: View API Pre-requisite Demo

Step 3: Call the API

1. Click Call API to execute the request.

2. Wait for the response to display.

Call API

Step 4: Extract Data from Response

1. Use Response Extractor to define extraction rules.

2. Select Response Type (JSON, XML, etc.).

3. Apply JSONPath/XPath to extract relevant values.

4. Click Extract to preview the data.

Extract Data

Step 5: Verify Extracted Data

• Click Verify to validate extracted values.

• Proceed to the next step if verification succeeds.

Limitations & Constraints

📏 Response Size:

• Comparison jobs support JSON responses > 6 MB.

• Configuration and table functions require responses ≤ 6 MB.

Supported Format:

Flat JSON

[
  {
    "UserId": "U001",
    "Food_Item": "Chicken Tenders",
    "Serving_Size_g": 574,
    "Calories": 269
  },
  {
    "UserId": "U002",
    "Food_Item": "French Fries",
    "Serving_Size_g": 450,
    "Calories": 365
  }
]

Nested JSON

{
  "Users": [
    {
      "UserId": "U001",
      "Details": {
        "Food_Item": "Chicken Tenders",
        "Serving_Size_g": 574,
        "Calories": 269
      }
    }
  ]
}