Aufgabenstellung

Der myDatanet Server bietet standardmäßig eine “REST API” Web-Schnittstelle an. Damit können die Daten welche am myDatanet Server bereitgestellt werden, in ein externes System eingebunden werden.

Übersicht

Benutzerverwaltung

Die Benutzerverwaltung erfolgt über das myDatanet-Portal. Die Zugriffsrechte eines angelegten myDatanet-Benutzers sind im Portal und auf der REST API - Schnittstelle ident.

Es ist auch möglich, einen separaten Benutzer vom Typ “Interface-Benutzer” rein für die API-Schnittelle über das Portal anzulegen.

Verwendung

Öffnen Sie den “rapidM2M Playground” entweder über den „API“-Link im myDatanet-Portal oder direkt über den Link https://<SERVER_URL>/api/1/doc und geben Sie Ihre Zugangsdaten ein:
( z.B. https://www.mydatanet.at/api/1/doc )

Jetzt sollten Sie bereits in der Lage sein, Ihre erste REST-API-Abfrage erfolgreich auszuführen, indem Sie den „Play“-Button drücken.
Die Abfrage

GET /1/me

liefert Informationen über den gerade abfragenden Benutzer, die als JSON-Objekt im rechten Bildschirmbereich ausgegeben werden.

Im Menü auf der linken Seite können andere Abfragen ausgewählt werden, die in thematische Sektionen gegliedert sind. Die Dokumentation der verschiedenen Felder erscheint nach der Auswahl im mittleren Teil der Seite.

Der Link zum „API Quick Guide“ bietet Ihnen weitere hilfreiche Informationen und ist ein guter Ausgangspunkt für die Integration in Drittsysteme.

Einige nützliche Codeausschnitte, die Sie direkt in das Befehlsfenster einfügen können:

Abfrage Kundenliste

Die Abfrage liefert eine detailierte Auflistung aller Kunden, die vom abfragenden Benutzer eingesehen werden dürfen.

GET /1/customers

Abfrage Messstellenliste

Die Abfrage liefert eine detailierte Auflistung aller Messstellen innerhalb des angegebenen Kunden.

GET /1/customers/$CID/sites

Die Platzhaltervariable $CID setzt automatisch den über das Auswahlmenü darüber ausgewählten Kunden ein.

Stellen Sie sicher, dass Sie den richtigen Kunden ausgewählt haben:

Abrage des “Blueprint” einer Messstelle

Verwenden Sie diese Abfrage, um herauszufinden, welche Ressourcen (historische Daten, Konfigurationen) für die Site verfügbar sind.

GET /1/customers/$CID/sites/$SID/blueprint

Die Werte für die Platzhaltervariablen $CID (Customer-ID) und $SID (Site-ID) werden automatisch entsprechend dem ausgewählten Kunden bzw. der Messstelle eingesetzt.

Bitte verwenden Sie für ihre finale API Anbindung die Site-UID anstatt des Site- und Kundennamens in der Abfrage. Siehe Hinweis zur API-Anbindung

Abfrage der jüngsten historischen Aufzeichnungswerte

Die Abfrage liefert die jüngsten Rohwerte der Zeitreihendaten der Site (histdata0 bis histdata9 verfügbar).

GET /1/customers/$CID/sites/$SID/histdata0/youngest
{
  "select": [
    "ui1",
    "ui2",
    "ui3",
    "ui4"
  ]
}

Abfrage von Zeitreihendaten

Die Abfrage liefert einen Bereich an Rohwerten der Zeitreihendaten der Site (histdata0 bis histdata9 verfügbar).

GET /1/customers/$CID/sites/$SID/histdata0
{
  "select": [
    "ui1",
    "ui2",
    "ui3",
    "ui4"
  ],
  "from": "20240601",
  "until": "*"
}

Weitere nützliche Abfragen

Positionsdaten der Messstelle
GET /1/customers/$CID/sites/$SID/pos/youngest
Konfigurationsdaten
GET /1/customers/$CID/sites/$SID/config1
Alarme (aktiv und/oder unquittiert)
GET /1/customers/$CID/sites/$SID/alarms

Hinweis zur API-Anbindung

Die Site-UID kann mit folgender Abfrage gelesen werden:

GET /1/customers/$CID/sites/$SID

Eine Abfrage des Blueprints unter Verwendung der Site-UID würde dann wie folgt aussehen:

GET /1/sites/<SITE-UID>/blueprint

Abschließend haben wir noch einige dieser Beispiele auch in Form einer Demo-Sammlung für den kostenlosen API platform development designer “Postman” (Postman API Platform | Sign Up for Free ) angehängt, wo Sie diese importieren und verwenden können.

Sie müssen lediglich Ihre Benutzeranmeldeinformationen sowie die Einstellunge für Server / Kunde / Site in den Collection-Einstellungen eingeben und diese vor dem ersten Durchlauf speichern.

Academy

How-To - REST-API Anbindung