Connect Devices via RESTful
About RESTful
Using RESTful, you can send HTTP requests (GET, POST, PUT, DELETE) to query resources. A resource can be anything that contains information, e.g., documents, images, or services.
Every resource has its own URL. Clients (e.g., Eliona) send HTTP requests to this URL. In response, clients receive status codes and representations of the requested data from the server, usually as .json or .xml.
In most cases, RESTful is used to integrate external devices or services into Eliona via a GET request through their API.
What is the difference between RESTful and Webhook?
The most significant difference is the direction of communication.
With RESTful, a client sends requests to a server. The server responds with a status code and (if possible) the requested data. For communication via RESTful, the exact address of the server, as well as the individual endpoints, must be known.
With Webhook, the communication originates from the server. The server actively sends data to the client in real time. The client does not have to send requests. For communication via webhooks, the server must know the address of the client.
Procedure
The procedure for integrating devices via RESTful can be divided into the following steps:
First, a connection is created and configured. This connection contains the base URL to an API.
In this connection, individual requests are created. The individual parameters that are to be queried are entered into these requests.
Overview
[A]
Menu "Connections"
Click to open the "Connections" menu
[B]
Tab
Access to the respective interfaces
[C]
Workspace
Shows a list of the existing connections (if any)
[D]
Connection
An existing connection
[E]
Show/hide requests
Click to show or hide requests assigned to this connection
[F]
Requests
Individual requests
[G]
Pause/resume connection
Click to pause or resume a connection
[H]
Connection status
Shows the current status of the connection
[I]
Name
Name of the connection
[J]
URL
The base URL of the respective connection
[K]
Requests
Shows how many requests are assigned to this connection
[L]
Add request
Click to add a request to the respective connection
[M]
New connection
Click to create a new connection
[N]
Connection details
Click to open the details of the respective connection. Opens the ↗Connection Details
[O]
Delete connection
Deletes the respective connection. ⚠ Caution: If the connection is also used in other projects, it will also be deleted there.
[P]
Request details
Click to edit the details of the respective request.
Create New Connection
In the sidebar, click on Connection [A]
▷ The "Connections" window opens
Select the RESTful [B] tab
In the workspace [C], a list of the already existing connections [D] is displayed
◈ If you do not see any entries, no connections exist yet
◈ Connections that have been configured in other projects are also displayed
Click on [M] to establish a new connection
▷ The ↗ "Configure RESTful Connection" window opens
Continue in chapter ↗ "Configure RESTful Connection"
Edit Existing Connection
In the sidebar, click on Connection [A]
▷ The "Connections" window opens
Select the RESTful [B] tab
In the workspace [C], a list of the already existing connections [D] is displayed
◈ If you do not see any entries, no connections exist yet
◈ Connections that have been configured in other projects are also displayed
Click on [M] to establish a new connection
▷ The ↗ "Configure RESTful Connection" window opens
Continue in chapter ↗ "Configure RESTful Connection"
Last updated