Rest Api Component

The REST API Component allows pipeline workflows to interact with external web services through standard HTTP methods. It can be used to retrieve, create, update, or delete data by connecting to RESTful APIs, making it a versatile integration option for both inbound and outbound data flows.

Key Capabilities

• Supports all major HTTP methods: GET, POST, PUT, PATCH, DELETE.

• Send requests with query parameters, headers, and authorization tokens.

• Configure request body payloads for POST, PUT, and PATCH.

• Handle pagination with iterations for bulk data retrieval.

• Control request execution with delay intervals.

Configuration Overview

All REST API configurations are grouped into the following sections:

• Basic Information

• Meta Information

• Resource Configuration

Configuring Meta Information

Source Name

• Provide a reference name for the API source.

• Example: CustomerOrdersAPI.

URL

• Enter the full endpoint URL of the REST service.

• Example: https://api.example.com/v1/customers.

Request Type

Select the HTTP method for the request:

• GET – Retrieve data from a resource.

• POST – Submit new data to a resource.

• PUT – Update an existing resource.

• PATCH – Partially update a resource.

• DELETE – Remove a resource.

Query Parameters

• Define additional parameters appended to the URL.

• Example:

  ?status=active&limit=100

Headers

• Provide additional metadata for the request.

• Common examples:

  • Content-Type: application/json

  • Accept: application/json

Authorization

• Configure credentials required to access the API.

• Options include Bearer Tokens, Basic Authentication, or API Keys, depending on the service.

• Example:

  Authorization: Bearer <token>

Iterations

• Configure the API to handle pagination when retrieving large datasets.

• Example: Fetching results in pages of 100 records.

Delay (in seconds)

• Specify a delay between requests when iterating or calling APIs in sequence.

• Useful for rate-limited APIs.

Body

• Enter the payload for requests (applies to POST, PUT, PATCH).

• Must be in the format required by the API (e.g., JSON, XML).

Example JSON Body:

{
  "customerId": "12345",
  "status": "active",
  "priority": "high"
}

Example Use Cases

• GET – Retrieve active customer details from an external CRM system.

• POST – Send processed orders from a pipeline to an ERP system.

• PUT/PATCH – Update customer profile details from pipeline data.

• DELETE – Remove outdated records in a third-party service.

• Paginated Iterations – Fetch transaction logs in batches of 500 records.

Best Practices

• Use Delay to comply with API rate limits.

• Always secure API calls with SSL/TLS and proper authorization headers.

• Test API responses with a small dataset before enabling large-scale iterations.

• Validate API body structure with sample requests before saving.