Zu Content springen
Deutsch
Mehr Unterstützung
Kontakt
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

📄 Kennzahlen per REST API verwalten

Dieser Artikel beschreibt, wie Key Performance Indicators (KPIs) über die ValueStreamer REST API erfasst, aktualisiert und verwaltet werden können. Er richtet sich an Entwickler oder IT-Verantwortliche, die KPI-Daten regelmäßig aus externen Systemen (z. B. ERP, MES, Data Warehouse) automatisiert an den ValueStreamer übertragen möchten.

🔍 Inhalt

  1. So funktioniert’s

  2. Weitere Hinweise

  3. Tipps & Best Practices

  4. Nächste Schritte

  5. FAQ

  6. Weiterführende Artikel

🛠️ So funktioniert’s
Die ValueStreamer REST API bietet eine Möglichkeit, Kennzahlen (KPIs) systematisch zu erfassen, zu lesen, zu aktualisieren oder zu löschen. Dies erfolgt über standardisierte Endpunkte auf Basis von JSON und OpenAPI 3.

1. Voraussetzungen

  • Zugriffsdaten (API Username, Passwort)

  • YAML-Datei (siehe Download unten)

  • Optional: Swagger UI für einfache Testumgebung

2. Download & Nutzung der YAML-Datei
👉 📥 YAML-Datei herunterladen
→ Im Swagger Editor öffnen (https://editor.swagger.io)
→ Endpunkte direkt testen oder Dokumentation strukturiert einsehen

3. Beispiel-Endpunkte (Auszug):

  • GET /api/exchange/kpi-data → Alle KPI-Datensätze abrufen

  • PUT /api/exchange/kpi-data/{date}/{teamId}/{kpiId} → Datensatz erstellen/aktualisieren

  • DELETE /api/exchange/kpi-data/... → Datensatz löschen

4. Authentifizierung
→ HTTP Basic Auth (Base64-kodierter API-Benutzer + Passwort)

📸 Screenshots (Beispiel: Swagger & API Editor):

  • Strukturierte Dokumentation in Swagger:

ℹ️ Weitere Hinweise

  • Nur der Kunde sendet aktiv Daten an die API (ValueStreamer führt keine automatischen PULLs/Pushs durch)

  • Die Kombination aus Datum, Team, KPI und (optional) Sub-Tile ist eindeutig – pro Tag nur ein Eintrag erlaubt

  • Datenaufnahme-Intervall (Tag, Woche, Monat) beeinflusst das Format der Datumsangabe

✨ Tipps & Best Practices

  • Für erste Tests empfiehlt sich Postman oder Swagger UI

  • Werte regelmäßig aktualisieren, um vollständige KPI-Darstellungen zu erhalten

  • Nur Werte für unterste Teamebene einpflegen (bei aggregierten KPIs)

  • Target-Werte können vorab eingegeben werden (z. B. Forecasts)

🚀 Nächste Schritte

  • Weitere API-Endpunkte kennenlernen

  • Kennzahlen automatisiert mit Scripts (z. B. in Python, Java) übertragen

  • Aggregierte Auswertungen über Sub-Tiles planen

❓ FAQ
Kann ich mehrere Werte auf einmal hochladen?
→ Ja, per JSON-Array im PUT-Request.

Wie finde ich die benötigten UUIDs für KPIs oder Teams?
→ Über die Meta-Endpunkte der API oder vorherige GET-Anfragen.

Was passiert, wenn ich für einen bestehenden Datensatz erneut PUT nutze?
→ Der Eintrag wird aktualisiert.

🔗 Weiterführende Artikel

  • [Tasks / Aufgaben API-Dokumentation]

  • [Deviations / Abweichungen API]

  • [Processboard API]