APIs¶

Überblick über die APIs der aedifion.io Cloud-Plattform.

Überblick¶

Wir bei aedifion sind der festen Überzeugung, dass ein erfolgreiches zukünftiges Gebäudeüberwachungs-, Analyse- und Steuerungssystem offen sein muss. Eine solche offene Lösung erlaubt es, z.B. Datenquellen, Dienste, Plattformen, Datenbanken, Ausgabekanäle usw. von Dritten frei zu integrieren. Umgekehrt kann sie auch in Dienste, Plattformen, Datenbanken, Ausgabekanäle usw. von Dritten integriert werden.

Das wichtigste Merkmal einer offenen Plattform ist eine umfassende, gut dokumentierte, freie und offene Programmierschnittstelle (engl. application programming interface, kurz API). Die aedifion.io Plattform bietet solche APIs für jeden Kunden an.

Dieser Artikel gibt einen kurzen Überblick über die APIs der aedifion.io Cloud-Plattform, ihre Funktionen und die wichtigsten Anwendungsfälle.

HTTP API¶

Alle Daten und Funktionen, die von der aedifion.io Plattform angeboten werden, können über eine RESTful HTTP API angesprochen und manipuliert werden. Dies beinhaltet z.B. das

Importieren, Abfragen und Exportieren von Zeitreihendaten
Erstellen und Verwalten von Warnmeldungen zu Daten und Metadaten
Verwalten von Benutzern, Projekten, Datenpunkten und Zugriffsberechtigungen
Erstellen und Verwalten aller Arten von Metadaten wie Tags, Umbenennungen, Favoriten usw.
Schreiben von Sollwerten und Zeitplänen für die aktive Gebäudesteuerung
...

Die aedifion.io HTTP API wird an verschiedenen Stellen aktiv genutzt, z.B.

interagiert das Frontend (www.aedifion.io) über die HTTP-APIs mit dem Backend
lädt das Excel-Plugin Daten aus der HTTP-API in Excel-Tabellenblätter
verwendet die interaktive 3D-Visualisierung die HTTP-API, um Sollwerte zu schreiben
lösen Sprachbefehle an Alexa Aufrufe der HTTP-API aus, um den thermischen Komfort abzufragen und Sollwerte zu schreiben
...

Noch mehr erfahren? Sehen Sie sich die schrittweisen Anleitungen zur Interaktion mit dieser API an oder erkunden Sie die zusätzlichen Entwickler-Ressourcen.

MQTT API¶

Die meisten Anwendungsfälle der aedifion.io Cloud-Plattform konzentrieren sich auf das Sammeln und Verarbeiten von Zeitreihendaten, die in Gebäuden, Anlagen oder ganzen Quartieren gesammelt werden. Wenn solche Daten (in Echtzeit) in oder aus der Plattform gestreamt werden sollen, ist das strenge Anfrage/Antwort-Muster der HTTP-APIs oft nicht die richtige Wahl. Daher ergänzen wir die HTTP-API durch eine MQTT-API. MQTT folgt einem Publish-Subscribe-Modell, das einen bequemen und effizienten Streaming-Zugang zu Live-Daten ermöglicht. Zu den Funktionen der MQTT-API gehören z.B.

das Abonnieren aller Messdaten, die von Ihren Gebäuden, Anlagen und Quartieren gesammelt werden, auf der Ebene ganzer Projekte oder bis hin zu einzelnen Datenpunkten
die Veröffentlichung von Daten in der aedifion.io Cloud-Plattform über MQTT
der Empfang von Benachrichtigungen und Alarmen über MQTT
die Unterstützung von Websockets
...

Die aedifion.io MQTT API wird an verschiedenen Stellen aktiv genutzt, z.B.

von aedifion's Edge Devices um gesammelte Daten und Metadaten an die aedifion.io Cloud-Plattform zu senden
abonniert die interaktive 3D-Visualisierung Live-Daten via MQTT direkt aus dem Browser über Websockets
veröffentlicht die aedifion.io Cloud-Plattform vom Benutzer erstellte Alarme zu Datenpunkten via MQTT

Noch mehr erfahren? Sehen Sie sich die schrittweisen Anleitungen zur Interaktion mit der MQTT-API an oder erkunden Sie die zusätzlichen Entwickler-Ressourcen.