Step-by-Step: Connecting to REST APIs with Microflow

Microflow
1

In ONEWEB, the Microflow Designer lets you integrate with external systems using REST APIs — without writing complex code. This guide walks you through creating a connection, sending a request, and handling the response.

1. Open Microflow Designer

  • Inside your AppSpace, go to the Microflow section.
  • Create a New Microflow and give it a clear name (e.g., GetCustomerData).

2. Add a REST Connector

  • Drag the REST API activity into your Microflow.
  • Choose the HTTP Method (GET, POST, PUT, DELETE) depending on the API you’re calling.

3. Configure the Endpoint

  • In the URL field, enter the API endpoint (e.g., https://api.example.com/customers).
  • If the endpoint has path variables or query parameters, map them to Microflow variables.

4. Set Up Headers and Authentication

  • Add any required HTTP headers (e.g., Content-Type, Accept, Authorization).
  • For secure APIs:
    • Use Basic Auth for username/password.
    • Or Bearer Token for OAuth2 / JWT.

5. Define Request Body (For POST/PUT)

  • If sending data, create a JSON or XML payload.
  • Map Microflow variables to the body fields.

6. Handle the Response

  • Define the Response Schema (JSON or XML).
  • Map the response fields to Microflow variables or entities for further processing.

7. Add Error Handling

  • Use Try-Catch or Error Event in Microflow to manage failed requests.
  • Log errors for troubleshooting.

8. Test Your Microflow

  • Run the Microflow in Test mode.
  • Check the request and response logs to verify integration is working.

:light_bulb: Pro Tip: Keep your API URLs, credentials, and headers in ONEWEB configuration variables so you can change them without editing the Microflow.