🔍 Inhalt
- Voraussetzungen
- Download & Nutzung der YAML-Datei
- Beispiel-Endpunkte (Auszug)
- Authentifizierung
- Technische Hinweise
- Tipps & Best Practices
- FAQ
Voraussetzungen
-
🔐 Zugriffsdaten (API-Username und Passwort)
-
📄 YAML-Datei (API-Spezifikation, siehe Download unten)
-
💻 Swagger UI oder Editor (https://editor.swagger.io/) für einfache Tests
📥 Download & Nutzung der YAML-Datei
-
👉 📥 YAML-Datei herunterladen
-
Öffnen Sie die Datei direkt im Swagger Editor: Swagger Editor öffnen
-
Testen Sie API-Endpunkte interaktiv oder verschaffen Sie sich einen strukturierten Überblick über die Dokumentation.
✨ Tipp:
Ziehen Sie die .yaml-Datei einfach in den Swagger Editor, um die API-Methoden direkt auszuprobieren und automatisch Client-Code zu generieren.
🔗 Beispiel-Endpunkte (Auszug)
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/api/exchange/kpi-data |
Alle KPI-Datensätze abrufen |
PUT |
/api/exchange/kpi-data/{date}/{teamId}/{kpiId} |
KPI-Datensatz erstellen oder aktualisieren |
DELETE |
/api/exchange/kpi-data/... |
KPI-Datensatz löschen |
📸 Screenshot: Swagger Editor – API-Dokumentation und Testumgebung
🔑 Authentifizierung
-
Authentifizierung erfolgt über HTTP Basic Auth.
-
API-Zugangsdaten werden als Base64-kodierte Zeichenkette übertragen.
-
Beispiel für den Authorization-Header:
Authorization: Basic <Base64-encoded-Username:Password>
📌 Technische 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 möglich.
-
📆 Das Datenaufnahme-Intervall (Tag, Woche, Monat) beeinflusst das erforderliche Datumsformat.
✨ Tipps & Best Practices
-
💡 Starten Sie API-Tests mit Swagger UI oder Postman, um die Konfiguration zu validieren.
-
📅 Halten Sie KPI-Werte regelmäßig aktuell, um vollständige und korrekte KPI-Darstellungen zu gewährleisten.
-
📊 Tragen Sie Werte nur für die unterste Teamebene ein – aggregierte Werte werden systemseitig berechnet.
❓ FAQ
Wie finde ich die benötigten UUIDs für KPIs oder Teams?
Über die Meta-Endpunkte der API oder durch vorherige GET-Anfragen.
Was passiert, wenn ich einen bestehenden Datensatz erneut per PUT hochlade?
Der bestehende Eintrag wird aktualisiert.