REST API

Überblick

Das REST-API-Modul verbindet DMAIC.io mit externen Datenquellen. Es ruft per HTTP-GET JSON-Daten von einer URL ab, mappt einzelne Felder auf Spalten im Arbeitsblatt und kann den Abruf wiederkehrend ausführen — z. B. um Messwerte aus einem Server, einer Maschinensteuerung oder einem Cloud-Dienst regelmäßig in das Arbeitsblatt zu schreiben.

Endpunkt: Ein gespeicherter Eintrag mit Name, URL, optionalen HTTP-Headern und einer Mapping-Tabelle. Pro Projekt lassen sich beliebig viele Endpunkte verwalten — z. B. einer pro Maschine oder pro Datenquelle.

JSON-Pfad: Eine Punktnotation, die in der API-Antwort einen bestimmten Wert oder ein Array adressiert (z. B. data.measurements oder result.values[*].temperature). Der Wert hinter diesem Pfad wird in die zugewiesene Worksheet-Spalte geschrieben.

Mapping (JSON-Pfad → Spalte): Eine Liste von Zuordnungen: Pro Eintrag wird ein JSON-Pfad einer Zielspalte im Arbeitsblatt zugewiesen. Beim Abruf werden die Werte gemäß diesen Mappings übernommen.

Schreibmodus: Steuert, wie die abgerufenen Werte in die Spalten geschrieben werden — entweder ersetzen (alte Werte werden überschrieben) oder anhängen (neue Werte werden unten angefügt). Anhängen eignet sich für laufende Datenerfassung.

Zeitplan (Schedule): Optionaler Wiederholungsabruf in Minuten oder Stunden. Solange das Modul geöffnet ist, ruft es den Endpunkt automatisch im eingestellten Intervall auf.

Bedienung

Endpunkt einrichten

• Mit „+" einen neuen Endpunkt anlegen und einen sprechenden Namen vergeben.
• URL eintragen — typischerweise eine REST-Schnittstelle, die JSON liefert.
• Bei Bedarf HTTP-Header ergänzen (z. B. Authorization für API-Keys oder Bearer Tokens).
• Mit dem Play-Button einen Testabruf starten — die Antwort wird zur Inspektion angezeigt.
• JSON-Pfade aus der Antwort identifizieren und je einer Worksheet-Spalte zuordnen.
• Schreibmodus wählen: ersetzen oder anhängen.
• Optional: Schedule aktivieren, Intervall in Minuten oder Stunden eintragen.

Endpunkte verwalten

• Endpunkte lassen sich duplizieren — praktisch für mehrere ähnliche Datenquellen.
• Beim Löschen eines Endpunkts wird ein laufender Schedule automatisch beendet.
• Der gesamte Zustand (Endpunkte, Mappings, Zeitpläne) wird beim Projekt-Export mit gespeichert.

Stolperfallen

CORS-Fehler: Browser blockieren standardmäßig API-Aufrufe an fremde Domains, wenn der Server keine CORS-Header sendet. Lösung: Endpoint serverseitig CORS-fähig machen oder einen Proxy verwenden. Symptome: Netzwerkfehler ohne Antwort.

Sensible Daten in Headern: API-Keys, Bearer Tokens und Passwörter werden im Klartext im Projekt gespeichert und beim Export mit ausgegeben. Daten vor dem Teilen prüfen oder Token regelmäßig rotieren.

Falscher JSON-Pfad: Tippfehler oder eine falsche Verschachtelungstiefe führen dazu, dass leere Spalten geschrieben werden. Vor dem produktiven Einsatz immer einen Testabruf machen und das Ergebnis prüfen.

Schreibmodus „Ersetzen" mit Schedule: Bei aktivem Schedule und „Ersetzen" wird der Sheet-Inhalt bei jedem Abruf überschrieben — alte Werte gehen verloren. Für Zeitreihen unbedingt „Anhängen" wählen.

Schedule läuft nur bei geöffnetem Modul: Der wiederkehrende Abruf läuft im Browser-Tab. Schließt man das Modul oder den Browser, stoppt der Schedule. Für echte Hintergrund-Erfassung ist ein Server-Job nötig.

Sehr kurze Intervalle: Intervalle unter einer Minute belasten den Browser und die Gegenseite stark. Für hochfrequente Daten lieber serverseitig puffern und in größeren Schritten holen.