REST API (6 min)

For our example, we will call a weather API and return the results to a web project. This includes a static variable with the label: result.

A static variable was created to hold two values, one for the API result and the other for the city the user selects in the web project.

1. Click the Any + icon, choose Custom API as the node, and click Next.

2. Provide the details for your API and click Next.

3. Add any parameters you may require. For our example, we required two according to our app. Click Next.

For our example, we did not require step 3. If you do require this step for your API, simple set your headers using the provided fields.

4. Use the Add Param icon to add required parameters to your node. For our example, we want to map part of the API result to the static variable.

5. Enter a Tag name and click Insert.

6. Click the Custom API + icon, choose Finish as the node, and click Next.

7. Enable the api_result variable and click Next.

8. Enter a Tag name and click Insert.

Save and publish your flow.

1. Navigate back to your web project.

2. Click the Interactivity icon from the button menu.

3. Click the Start + icon, choose the Flow node, and click Next.

4. Use the dropdown to select the Rest API Flow. 

5. Disable Run in Background.

6. Click Configure Parameters.

7. Configure the input_city as the City text input field. Click Apply.

8. Click Return Parameters.

9. Map the result variable to the field api_result. Click Apply.

10. Click Next, enter a Tag name, and click Insert.

When the user provides a city name and invokes the flow. The result will display in the field.