12.09.2018, 16:17
Funktion:
1. Allgemeines zur Query API
Mit der myGEKKO Query API kann ein Drittsystem auf die an myGEKKO angeschlossenen Systeme und Funktionen zugreifen und dessen Zustände abfragen sowie steuern. Die Query API wird über GET Anfragen über http/https aufgerufen, somit ist eine Abfrage auch über einen herkömmlichen Browser möglich. Die Query API bietet nicht nur die Möglichkeit Echtzeitwerte von Systemen abzufragen und zu steuern, sondern kann auch für die Abfrage von historischen Trendaufzeichnungen sowie Listen (z.B. Alarmlisten) verwendet werden.
2. Voraussetzungen und Sicherheitsaspekte:
Tutorial: myGEKKO & Query API (PDF)
Hinweis:
Um den Dienst verwenden zu können, muss der Plus Service "Query API" am Ihren myGEKKO aktiv sein:
Aktivierung Plus Service "Query API"
Wenn der Plus Service "Home Bundle" bereits aktiv ist, wird keine weitere Aktivierung benötigt um die Query API nutzen zu können.
Voraussetzung für die Nutzung der myGEKKO Plus Services ist ein myGEKKO Touch, myGEKKO Compact oder myGEKKO Slide und einfunktionierender Internetzugang für Ihren myGEKKO.
1. Allgemeines zur Query API
Mit der myGEKKO Query API kann ein Drittsystem auf die an myGEKKO angeschlossenen Systeme und Funktionen zugreifen und dessen Zustände abfragen sowie steuern. Die Query API wird über GET Anfragen über http/https aufgerufen, somit ist eine Abfrage auch über einen herkömmlichen Browser möglich. Die Query API bietet nicht nur die Möglichkeit Echtzeitwerte von Systemen abzufragen und zu steuern, sondern kann auch für die Abfrage von historischen Trendaufzeichnungen sowie Listen (z.B. Alarmlisten) verwendet werden.
Die Query API ist lokal auf unserem myGEKKO sowie über unsere myGEKKO Plus Dienste zugänglich wobei sich die zwei Varianten hauptsächlich durch die unterschiedlichen Authentifizierungsmechanismen unterscheiden. Im weiteren Kapitel werden die Unterscheidungen durch die Abkürzungen „LOKAL“ und „PLUS“ deutlich gemacht.
2. Voraussetzungen und Sicherheitsaspekte:
LOKAL:
Um die lokale Query API zu nutzen muss Ihr myGEKKO im Netzwerk angeschlossen sein und der lokale Webzugang HTTP/HTTPS unter den myGEKKO Security Einstellungen aktiv sein. Weiters muss unter myGEKKO Web ein lokaler Webbenutzer angelegt sein.
Achtung: Die lokale Query API ist auch über http (Port 80) erreichbar und deshalb sollte der lokale Webzugang nur in gesicherten Netzwerken verwendet werden und das Port 80 nie direkt ohne Schutz, z.B: VPN, öffentlich zugänglich gemacht werden.
PLUS:
Um die Query API über unsere myGEKKO Plus Dienste zu nutzen, muss Ihr myGEKKO an den myGEKKO Plus Diensten angemeldet sein und den Dienst myGEKKO Query API abonniert haben. Weitere Infos entnehmen Sie dem Handbuch „myGEKKO Plus Dienste“.
Der Zugang zur Query API ist nur über https erreichbar, http ist aus Sicherheitsgründen nicht erlaubt.
Das gesamte Tutorial finden Sie unter dem folgenden Link:
Tutorial: myGEKKO & Query API (PDF)
Hinweis:
Um den Dienst verwenden zu können, muss der Plus Service "Query API" am Ihren myGEKKO aktiv sein:
Aktivierung Plus Service "Query API"
Wenn der Plus Service "Home Bundle" bereits aktiv ist, wird keine weitere Aktivierung benötigt um die Query API nutzen zu können.
Voraussetzung für die Nutzung der myGEKKO Plus Services ist ein myGEKKO Touch, myGEKKO Compact oder myGEKKO Slide und einfunktionierender Internetzugang für Ihren myGEKKO.