What is a REST API?
REST stands for Representational State Transfer. REST is an architectural style for designing networked applications. RESTful APIs adhere to these principles to build scalable, reliable, and maintainable web services. Here are some key concepts:
Resources: In a RESTful system, everything is a resource. These resources can be anything—data, services, or even processes. Each resource is uniquely identified by a URI (Uniform Resource Identifier).
HTTP Methods: RESTful APIs use standard HTTP methods (GET, POST, PUT, DELETE) to perform actions on resources. For example, GET to retrieve data, POST to create a new resource, PUT to update an existing resource, and DELETE to remove a resource.
Statelessness: Each request from a client to a server contains all the information needed to understand and fulfill that request. The server doesn't store any information about the client's state between requests. This makes the system scalable and easy to maintain.
How can I use the REST API Widget?
To use Flowrabbit's REST API Widget, follow these steps:
1. Click on the Widget Icon (cloud) in the top bar. Choose "Rest" and place the widget anywhere on the canvas. Do not place it on a screen.
2. Double-click on the Widget or click once and then click on "Configuration" in the right panel to open the dialog to set up your REST API Widget.
3. Choose whether you want to GET, POST, PUT, or DELETE.
4. In the "Response" tab, you can specify the Output Variable, Path, and Type.
5. In the "Request" tab, you can use the ${databinding} notation to access data from your Flowrabbit Application (e.g., User inputs).
6. In the "Header" tab, add your authentication tokens.
7. The "Test Parameter" and "Test Result" Tabs are here for you to test the REST API Widget without having to run your Flowrabbit Application.
8. Once you've finished setting up your REST API Widget, click "Ok."
9. Lastly, connect the Widget to the relevant screens using the "Data & Logic"-View (database icon on small screens).