ReST

Learn how to use the ReST action in DBSync Cloud Workflow

Introduction

The ReST Action in DBSync Cloud Workflow enables users to interact with any RESTful web service within their workflows. This action is versatile and allows you to send HTTP requests, enabling seamless integration with various external services and APIs. This guide provides step-by-step instructions on setting up, configuring, and using the ReST action effectively.

Prerequisites

• An active DBSync Cloud Workflow account.

• The endpoint URL of the RESTful web service you intend to connect to.

• API credentials (if required by the endpoint) and necessary access permissions.

Setting Up a ReST Action

Create or Open a Workflow

1. Log in to DBSync Cloud Workflow.

2. Navigate to Workflows and either create a new workflow or select an existing one.

3. Add a new Action Step.

Configure the ReST Action

1. Select ReST Action from the list of available actions.

2. Enter the following details:

   • Request Name: A descriptive name for the action.

   • Method: Choose the HTTP method (GET, POST, PUT, DELETE, PATCH).

   • Endpoint URL: Provide the full URL of the API endpoint.

1. Configure additional options:

• Headers: Add custom headers such as Content-Type or Authorization for authenticated requests.

• Query Parameters: Specify any query strings needed by the endpoint.

• Body (for POST, PUT, PATCH): Include the request payload in JSON, XML, or any supported format.

Authentication Setup

If the API requires authentication:

1. Select the appropriate Authentication Type from:

   • No Auth: No authentication required.

   • API Key: Provide the key and its location (header, query).

   • Bearer Token: Enter the token for authorization.

   • Basic Auth: Enter username and password.

   • OAuth 2.0: Configure using the OAuth details, including client ID, client secret, and token URL.

2. Save the authentication settings.

Map Data Fields

1. Use the Field Mapping Tool to map data from other workflow steps or sources to the ReST Action request fields.

2. Configure transformations if needed to modify the data before it is sent.

Executing a ReST Action

Test the Action

1. Save your workflow configuration.

2. Click Run Test to execute the ReST Action and observe the response.

3. Review the response data and logs to ensure the action works as intended.

Use the Response

• Capture Output: Store response data for use in subsequent workflow steps by mapping output fields.

• Conditional Logic: Set conditions based on response status codes (e.g., 200 OK, 400 Bad Request) to control workflow behavior.

Common Use Cases

Retrieve Data from an External API

1. Select GET as the method.

2. Provide the Endpoint URL and any necessary headers.

3. Run the workflow to retrieve data, and map the response fields for use in downstream actions.

Send Data to a Third-Party Service

1. Select POST or PUT as the method.

2. Configure the Body with data mapped from previous workflow steps.

3. Include any required headers (e.g., Content-Type: application/json).

4. Test and save the action to send data.

Update Data via PATCH Request

1. Choose PATCH and specify the Endpoint URL.

2. Include the partial data in the Body that you want to update.

3. Save and execute the workflow to make the update.

Advanced Configuration

Dynamic Variables in URLs and Headers

• Use Placeholders (e.g., {{variable_name}}) in the URL, headers, or body to dynamically insert data at runtime.

Handling Large Payloads

• For large payloads, ensure the endpoint supports chunked transfer or increase the timeout setting in the ReST Action to avoid interruptions.

Error Handling and Debugging

Common Issues

• 401 Unauthorized: Check authentication credentials and token validity.

• 404 Not Found: Verify that the endpoint URL and resource path are correct.

• Timeout Errors: Increase the action timeout or check the network status.

Debugging Tips

• Log Responses: Enable response logging to capture the details of API interactions.

• Use Test Mode: Run the ReST Action in test mode to monitor real-time response data without affecting production workflows.

Best Practices

• Secure API Keys: Store API keys in a secure environment and avoid hardcoding them in workflows.

• Optimize API Calls: Minimize API calls by using only necessary data fields and parameters.

• Monitor API Limits: Be aware of the rate limits imposed by the API provider to prevent overuse.

The ReST Action in DBSync Cloud Workflow provides a powerful way to connect with and automate data flows involving any RESTful service. By following this guide, users can configure and execute ReST Actions effectively to enhance their workflow automation and data integration processes.