RESTful

Content of the chapter: Configuration of RESTful

The RESTful feature is used in Eliona to link online data with formats. For example, it can be used to get data from the openweathermap API.

RESTful overview

1. Pause/enable connection: Click to pause or to enable the connection.
2. Name: Name of the connection.

3. URL: Shows the URLs of connections.

4. Requests: Shows the number of requests of connections.

5. Search function: Search for connections.

6. Sort: Sort the connections by status, name or URL.

7. Create connection: Click to create a new connection.
8. Add request: Click to create a request.
9. Remove Connection: Click to delete the connection.
10. Configure Connection: Click the arrow to configure the connection.

11. Name: Name of the linked request

12. Method: Shows the HTTP-Method of the request.

13. Endpoint: Displays the URL for the endpoint.

14. Interval: Indicates the configured time interval.

15. Remove request: click to remove the request.
16. Configure request: Click the arrow to configure the request.

Connection Configuration

Connection configuration

1. Pause/enable connection: Click to pause a connection and click to activate the connection.

2. Name: Enter the name of the connection.

3. Base URL: Enter the base URL

4. Authentication: Choose between No Authentication, Basic Authentication, API Key and Bearer Token.

5. Host: Enter the host.

6. Port: Enter the port.

7. Username: Enter your login username.

8. Password: Enter your password.

9. Create/Cancel: Click Create to keep the changes.

10. Requests: List of all existing requests.

11. Search: Search existing requests from the list.

12. Sort: Sort requests by name, method, format, endpoint, or interval.

13. Request: Click to create a request.

Request Configuration

Request Configuration

1. Test request: Click to test the request and get a report of the test.

2. Name: Name the request.

3. Path: Enter the URL address.

4. Interval: Interval in seconds.

5. HTTP Method: Select the request method.

6. Format: Select a format for the request.

7. Create Format: Create a new format.

8. Request Editor: Select between Parameters, Headers, Authorization and Body.

9. Create Parameters: Click to create new parameters.

10. Save/Cancel: Click Save or Cancel to keep or discard the changes.

Parameters

Enter the key and value and click the check mark.

Parameter Configuration

Headers

Enter the key and value and click the check mark.

Authorization

Select the authentication between No Authentication, Basic Authentication, API Key and Bearer Token.

Authorization Configuration

Body

Body editor allows you to define the message body to be sent to the API.

Body Configuration