REST API
This page provides an overview of the REST API connection, which enables you to make API requests from within your application.
This page outlines the following aspects of the REST API connection:
This table outlines the required information to configure a REST API connection:
Configuration field | Description |
|---|---|
Connection Name | Name of your connection. |
URL | Base URL of the endpoint on which to make requests. |
The REST API connection allows you to define one or more Actions, where each Action stores the parameters for a specific request. For example, you can define one Action for a
GET request and another for a POST request. The screenshot below shows how the first Action is configured as a GET request:
Each Action you define becomes a selectable component reference when working in the Logic view that you can drag onto your app. The following screenshot shows the component references corresponding to the two Actions in the previous screenshot:
The following table outlines the parameters you can configure for an Action:
Parameter | Type | Description |
|---|---|---|
Method | string | Verb to use for the request (e.g., POST, GET, PUT, PATCH, etc.). |
Path | string | Path of the specific API endpoint to send the request. Note: You can turn a URL subdirectory item into a path variable by prepending it with a colon. For example, the following URL creates a path variable for the last item in the URL subdirectory: https://dummyjson.com/docs/:products. |
Query Params | string | Query parameters to append to the request string. Uiflow appends each key/value pair in the form of key=value. |
Content Type | string | Format of the request's body (e.g. application/json). |
Body | object | Data to send to the endpoint. Uiflow constructs the body as an object containing each key/value pair. |
Headers | object | Headers to include in the request. Set Key to the header name (e.g. Accept) and Value to the header's value (e.g. application/json). |
Note: Enable Raw to view and edit the parameter as a string. The following screenshot shows the raw edit mode for Body:
You can assign a unique name for each Action by modifying the Action Name field. The Component Preview section shows how the component looks for the currently selected action:
To expose a parameter of your connection component as a node, click Expose above the parameter field:
Exposed parameters appear as nodes on the left of the connection component allowing you to connect them to other component's nodes when working in the Logic view.
Last modified 1mo ago