🏆
Eliona
German
German
  • 💡Vorwort
    • Willkommen!
    • Über dieses Dokument
    • Typographische Konventionen
    • Das Interface
    • Bedienelemente
    • Glossar
    • FAQ
  • 🎉Neue Funktionen
    • Changelog – Aktuelle Version: v14.0.4
  • 🎓Academy
    • Eliona als Ticketing Plattform
      • Anleitung aus Sicht Admin
      • Anleitung aus Sicht Service
      • Anleitung aus Sicht Kunde
    • Einführung in Ontologien
      • Einführung in die Haystack Ontologie
      • Einführung in die Brick Ontologie
      • Einführung in die RealEstateCore Ontologie
      • Wie deckt Eliona Ontologien ab
    • Einen Zählerwechsel konfigurieren
    • Aggregationen in Eliona
    • White-Labeling
    • Ein Projekt erstellen
    • Einen Benutzer erstellen
    • Benutzer zu einem Projekt hinzufügen
    • Eine Rolle erstellen
    • Einem Benutzer eine Rolle zuordnen
    • Ein Asset erstellen und konfigurieren
    • Ein Dashboard erstellen
    • Eine Analytic erstellen und konfigurieren
    • Einen Alarm konfigurieren
    • Einen Digitalen Zwilling anlegen
    • Wie “Wayfinding” funktioniert
    • Werte-Mapping in Eliona
    • Twig-Templating in Eliona
    • Einführung und Tour durch die Benutzeroberfläche
  • 📚Dokumentation
    • 🗺️Wayfinding
      • Ein neues Wayfinding-Gebäude mit Stockwerken erstellen
      • Ein bestehendes Gebäude bearbeiten
      • Ein bestehendes Stockwerk öffnen
      • Ein Wayfinding Stockwerk konfigurieren
      • QR-Code generieren
      • Wayfinding in der Nuzung
    • 📊Dashboard
      • Ein neues Dashboard erstellen
      • Widgets zum Dashboard hinzufügen
      • Zwischen Dashboards wechseln
      • Layout von Dashboards anpassen
      • Dashboards organisieren
      • Dashboards an Benutzer kopieren
      • Globale Dashboards
      • Dashboard Templates
    • 🧊Widgets
      • Widgets bedienen
      • Vordefinierte Widgets
        • Alarm
        • Alarmübersicht
        • Analog Eingabe
        • Analoger Trend
        • Analyse
        • Asset Tracking
        • Behaglichkeit
        • Bereichsdiagramm
        • Bild
        • Buchung
        • Digitaler Trend
        • Donut
        • Einfache Anzeige
        • Eingabe Auswahl
        • Eingabe Schalter
        • Fahrplan
        • Fortschritt Radial
        • Fortschritt Vertikal
        • Heatmap
        • HLK KPI
        • iFrame
        • Kalender
        • Karte
        • Kombinierte Trends
        • Lichtsteuerung
        • Links
        • Radar-Diagramm
        • Reporttabelle
        • Sankey-Diagramm
        • Schalter
        • Slider
        • Stockwerk
        • Temperaturbereiche
        • Ticketübersicht
        • Tracking heatmap
        • Trend mit Balken
        • Trigger
        • Wetter
        • Zwei analoge Trends
        • Zwei digitale Trends
      • Benutzerdefinierte Widgets
        • Detaillierte Liste der Alarme
        • Liste der Alarme
        • Module
          • Alarm
          • Bereich
          • Bild
          • Custom Stockwerk
          • Donut
          • Eingaben & Schalter
          • Fortschritt
          • Heatmap
          • Icon
          • iFrame
          • Kalender
          • Karte
          • Komfort
          • Links
          • Radar
          • Sankey
          • Tabelle
          • Ticket
          • Tracking
          • Trend
          • Uhrzeit
          • Wert
          • Wetter
    • 🎈Assets
      • Assets erstellen
      • Asset-Details
      • Ein Asset konfigurieren
      • QR-Codes generieren
      • Bewertungen
      • Asset Daten
      • Dokumente an Assets anhängen
      • Einem Asset Links hinzufügen
      • Asset-Status: Aktive / Inaktive / Nicht Überwachte Assets
      • Assets auf einer Karte platzieren
      • Assets strukturieren
      • Assets archivieren
      • Asset-Modellierung: Templates erstellen
        • Ein neues Template erstellen
        • Ein neues Asset-Charakteristik-Template erstellen
      • ❤️Die Template-Bibliothek
        • Ein Template importieren
        • Ein Template Exportieren
    • 🎛️Smart Views
      • Eine neue Smart View erstellen
      • Eine bestehende Smart View öffnen
      • Eine Smart View konfigurieren
      • Eine Smart View bereitstellen
      • Slider Gruppen
      • Smart Assist
    • ⏰Alarme, Regeln und Eskalationen
      • 🚦Regeln
        • Eine Regel erstellen
      • 🚨Alarme
        • Quittierpflichtige und Gehende Alarme
        • Alarmstatistik
      • ↗️Eskalationen
        • Eine Neue Eskalationen erstellen
        • Eine Eskalation konfigurieren
        • Nutzer für Eskalationen konfigurieren
        • Notification Provider
          • Mail
          • Google Chat
          • SMS
          • Slack
          • eCall-Services
          • Job diagnostic
        • Allgemeinen Kalender erstellen
        • Eskalationen gruppieren
      • ⛓️Regelketten
        • Die Regelketten Seite öffnen
        • Eine neue Regelkette erstellen
        • Die Konfiguration einer bestehenden Regelkette öffnen
        • Regelkette konfigurieren
    • 🎟️Tickets
      • Tickets erstellen
      • Ticket Einstellungen
      • Ticket konfigurieren
      • Ticket-Details
      • Tasks erstellen
      • Task starten und abschliessen
      • Tickets schliessen
    • 📈Analytics & Reports
      • Analytics Nutzen
      • Reports Nutzen
    • 🌍Karte und Stockwerk
      • Karte
      • Stockwerk
        • Ein Stockwerk erstellen
        • Assets auf einem Stockwerk platzieren
        • Räume erstellen
        • Localino Anker konfigurieren
    • 🏛️BIM
      • Ein BIM öffnen
      • In einem BIM navigieren
      • Ein neues BIM erstellen
      • Assets in einem BIM platzieren
    • 📫Benachrichtigungen
      • Interne Benachrichtigungen
      • Benachrichtigungen Stumm Schalten
      • Push-Benachrichtigungen
      • Benachrichtigungen anpassen
    • 👥Digitaler Zwilling
    • ⚙️Engineering
      • Skript Engine
        • Skripte konfigurieren
        • Python Skripte schreiben
          • Output Logging und Fehlerbehandlung
          • Vorinstallierte Python-Bibliotheken im Eliona-System
          • Erstellen und Lesen von Dateien
        • PL/PgSQL-Skripte schreiben
      • Asset-Modellierung / Templates
        • Ein neues Template erstellen
        • Ein neues Asset-Charakteristik-Template erstellen
    • 🔧Einstellungen
      • Apps
        • Asset-Filter
      • Audit Trail
      • Lizenz
        • Lizenz läuft ab
      • System
      • API-Schlüssel
    • 🚩Tags
    • 🔮Systeme und Projekte
      • Ein neues Projekt erstellen
      • Benutzer zu einem Projekt hinzufügen
      • Aussehen eines Projekts anpassen
      • Startseite
      • Zwischen Projekten wechseln
    • 🧑‍💻Benutzer
      • Einen neuen Nutzer anlegen
      • Einen Nutzer einem Projekt zuweisen
      • Rolle eines Nutzers ändern
      • Zugriffsrechte von Nutzern verwalten
      • Benutzer archivieren und wiederherstellen
      • Benutzerdaten anpassen
    • 🎭Rollen
      • Warum sind Rollen so wichtig?
      • Das Rollen-Menü
      • Systemrollen
      • Projektrollen
    • 👾Weitere Funktionen
      • 📑Attribut Funktionen
        • ➗Werte berechnen: Der Calculator
        • 🕵️Filter
        • 📈Gerätesimulator
      • 🪃Lesezeichen
      • Tracking
      • 👀Monitoring
        • Monitoring mit Grafana
        • HDD Monitor
      • 🤳Augmented Reality
      • 🚢Bulk Import
  • 📶connectivity as a service
    • Geräte mit Eliona verbinden
      • Geräte per Modbus verbinden
        • Neue Modbus-Verbindung erstellen
        • Jobs lesen
      • Geräte per MQTT verbinden
        • Neuen Client erstellen
        • Client konfigurieren
        • Eine Subscription konfigurieren
        • Eine Publication konfigurieren
        • Eliona Broker
      • Geräte per RESTful verbinden
        • RESTful Verbindung konfigurieren
        • RESTful Request konfigurieren
      • Geräte per Webhook verbinden
      • ...mit Kafka
        • Eine neue Verbindung aufbauen
        • Verbindung konfigurieren
        • Abonnement konfigurieren
        • Publication konfigurieren
      • Geräte per OPC UA verbinden
        • Einen Endpunkt erstellen und konfigurieren
        • Endpunkt-Details
        • Verbindungs-Details
      • Ein Format konfigurieren
        • Format Konventionen und Beispiele
      • Funktionen
  • Edge Nodes
    • Was sind Edge Nodes?
    • EdgeNodes in Eliona
      • Control Edge einrichten
        • Eliona-Module für Niagara
  • 🍎Apps
    • Apps
      • ABB free@home
      • Akenza
      • Buchung
      • CoffeeCloud
      • Correlation App
      • Device simulator
      • Exchange-App
      • Forecast
        • Was ist Forecasting
        • Forecast App einfach nutzen
        • Parameter richtig Wählen
          • Alle Parameter auf einem Blick
        • Ablauf der Forecast App
        • Was sind Hyperparameter?
        • Parameter Konfiguration
        • Training Parameter einstellen
        • Binäre und Mehrklassen-Prognosen
        • Automatische Parameter
        • API-Dokumentation
        • Use Cases
      • Glutz
      • GP Joule
      • Hailo
      • Kentix
      • KentixONE
      • Kontakt.io
      • Localino
        • Geofencing-Funktion im Localino-System
      • Loriot.io
      • Microsoft 365
      • Microsoft ADFS
      • myStrom App
      • Niagara
      • OpenBOS
      • Renzbox
      • ROOMZ
      • SAML SSO
      • Signify
      • Spread Sheet
      • Stoppuhr
      • Thingdust
      • Xovis
      • Xovis People Counter
      • Zevvy
    • App SDK
  • 📢Feedback
    • 🐛Einen Bug melden
    • 💝Verbesserungsvorschlag senden / Feature wünschen
  • 👩‍💻Für Entwickler
    • REST API
    • Engineering
Powered by GitBook
On this page
  • Über RESTful
  • Was unterscheidet RESTful von Webhook?
  • Vorgehen
  • Überblick
  • Neue Verbindung erstellen
  • Bestehende Verbindung bearbeiten

Was this helpful?

  1. connectivity as a service
  2. Geräte mit Eliona verbinden

Geräte per RESTful verbinden

PreviousEliona BrokerNextRESTful Verbindung konfigurieren

Last updated 8 months ago

Was this helpful?

Über RESTful

Über RESTful können Sie HTTP Anfragen (GET, POST, PUT, DELTE) senden, um Ressourcen abzufragen. Eine Ressource kann alles sein, was Informationen enthält, z.B. Dokumente, Bilder oder Dienste.

Jede Ressource verfügt über eine eigene URL. Clients (z.B. Eliona) senden HTTP-Anfragen an diese URL. Als Antwort erhalten die Clients vom Server Status-Codes und Repräsentationen der angefragten Daten, meist als .json oder .xml.

In den meisten Fällen wird RESTful verwendet, um externe Geräte oder Dienste per GET-Request über deren API in Eliona einzubinden.

Was unterscheidet RESTful von Webhook?

Der bedeutendste Unterschied ist die Richtung der Kommunikation.

  • Mit RESTful sendet ein Client Anfragen an einen Server. Der Server antwortet mit einem Status-Code und (falls möglich) den angefragten Daten. Bei Kommunikation über RESTful muss die genaue Adresse des Servers, so wie der einzelnen Endpunkte bekannt sein.

  • Bei Webhook geht die Kommunikation vom Server aus. Der Server sendet aktiv und in Echtzeit Daten an den Client. Der Client muss keine Anfragen stellen. Bei einer Kommunikatiojn über Webhooks muss der Server die Adresse des Clients kennen.

Vorgehen

Das Vorgehen, um Geräte per RESTful einzubinden lässt sich in folgende Schritte unterteilen:

  1. Zuerst wird eine Verbindung angelegt und konfiguriert. Diese Verbindung enthält die Basis-URL zu einer API.

  2. In dieser Verbindung werden einzelne Requests angelegt. In diese Requests werden die einzelnen Parameter eingetragen, die abgefragt werden sollen.

Überblick

Symbol
Beschreibung
Details

[A]

Menü „Verbindungen“

Klicken, um das Menü „Verbindungen“ aufzurufen

[B]

Reiter

Zugriff auf die jeweiligen Schnittstellen

[C]

Arbeitsbereich

Zeigt eine Liste der bestehenden Verbindungen an (wenn vorhanden)

[D]

Verbindung

Eine bestehende Verbindung

[E]

Requests einblenden/ausblenden

Klicken, um Requests, die dieser Verbindung zugeordnet sind einzublenden oder auszublenden

[F]

Requests

Einzelne Requests

[G]

Verbindung pausieren/wieder aufnehmen

Klicken, um eine Verbindung zu pausieren bzw. wieder zu starten

[H]

Status der Verbindung

Zeigt den aktuellen Status der Verbindung an

[I]

Name

Name der Verbindung

[J]

URL

Die Basis-URL der jeweiligen Verbindung

[K]

Requests

Zeigt an, wie viele Requests dieser Verbindung zugeordnet sind

[L]

Request hinzufügen

Klicken, um der jeweiligen Verbindung einen Request hinzuzufügen

[M]

Neue Verbindung

Klicken, um eine neue Verbindung zu erstellen

[N]

Verbindungs-Details

Klicken, um die Details der jeweiligen Verbindung aufzurufen. Öffnet die ↗Verbindung-Details

[O]

Verbindung löschen

Löscht die jeweilige Verbindung. ⚠ Achtung: Wenn die Verbindung auch in anderen Projekten genutzt wird, wird sie dort ebenfalls gelöscht.

[P]

Request-Details

Klicken, um die Details des jeweiligen Requests zu bearbeiten.

Neue Verbindung erstellen

  1. Klicken Sie in der Seitenleiste auf Verbindung [A] ▷ Das Fenster „Verbindungen“ öffnet sich

  2. Wählen Sie im Reiter RESTful [B] aus

  3. Im Arbeitsbereich [C] wird eine Liste der bereits bestehenden Verbindungen [D] angezeigt ◈ Wenn Sie keine Einträge sehen, bestehen noch keine Verbindungen ◈ Es werden auch Verbindungen angezeigt, die in anderen Projekten konfiguriert wurden

Bestehende Verbindung bearbeiten

  1. Klicken Sie in der Seitenleiste auf Verbindung [A] ▷ Das Fenster „Verbindungen“ öffnet sich

  2. Wählen Sie im Reiter RESTful [B] aus

  3. Im Arbeitsbereich [C] wird eine Liste der bereits bestehenden Verbindungen [D] angezeigt ◈ Wenn Sie keine Einträge sehen, bestehen noch keine Verbindungen ◈ Es werden auch Verbindungen angezeigt, die in anderen Projekten konfiguriert wurden

Klicken Sie auf [M], um eine neue Verbindung aufzubauen ▷ Es öffnen sich das Fenster

Fahren Sie fort in Kapitel

Klicken Sie auf [M], um eine neue Verbindung aufzubauen ▷ Es öffnen sich das Fenster

Fahren Sie fort in Kapitel

📶
↗ "RESTful Verbindung konfigurieren"
↗ "RESTful Verbindung konfigurieren"
↗ "RESTful Verbindung konfigurieren"
↗ "RESTful Verbindung konfigurieren"
Abb. 1 – Verbindungen RESTful
Abb. 2 – Verbindungen RESTful (Details)