REST API

In Burq, go to Apps to view the list of connectors you have licensed. Burq provides an HTTP(S) connector that allows you to integrate with REST API. This section explains how to set up a REST API connection and use it inside a workflow.

Create a New HTTP(S) Connection

  1. Navigate to Apps → HTTP(S) from the Burq dashboard.
  2. Click Add instance and provide a name.
  3. Configure the following fields (click the Edit option next to your instance):
  4. Connection Name → A user-friendly name for the connection.
  5. Authorization Type → Choose the type of authentication required by the API (e.g., OAuth 2.0, API Key, or None).
  6. URL → Base URL of the API
  7. Grant Type → Select Client Credentials.
  8. Client ID → Provided by the API provider.
  9. Client Secret → Provided by the API provider.
  10. Access Token URL → The endpoint where Burq requests an access token.

Use the Connection in a Dataflow

Once the connection is created, you can use it inside a workflow orchestration.

  1. Go to Workspace → Dataflow → Orchestration.
  2. Drag an HTTP(S) step into the workflow.
  3. Select the connection you created earlier.
  4. Configure the request: