🔍 Inhalt
Voraussetzungen
-
🔐 API-Zugangsdaten (Username + Passwort für HTTP Basic Auth)
-
🌐 Base URL:
https://api-<tenant>.valuestreamer.de/api/ -
📄 API-Spezifikationen (PDF & YAML) – siehe 📚 API-Dokumentationen & YAML-Dateien zum Download
-
💻 Ein geeignetes API-Test-Tool (z. B. Postman, Swagger Editor) oder eine Middleware
🏗️ Systemarchitektur
Der ValueStreamer läuft in der Microsoft Azure Cloud und ist modular aufgebaut:
-
Frontend: Browserbasierte Benutzeroberfläche
-
Backend: REST API als zentrale Schnittstelle
-
Datenbank: Azure MySQL (SSL-verschlüsselt)
-
Authentifizierung: HTTP Basic Auth mit Benutzername & Passwort
📸 Screenshot: Architekturübersicht
🔗 Funktionsweise der Middleware-Integration
Die REST API arbeitet passiv – sie wartet auf Anfragen, führt aber keine aktiven Push-/Pull-Mechanismen aus.
Ablauf einer typischen Integration:
-
Kundensystem (z. B. MES, ERP) sendet Daten an die Middleware.
-
Middleware verarbeitet, transformiert und mappt die Daten.
-
Middleware überträgt die Daten im JSON-Format via REST API an ValueStreamer.
-
API sendet Antwort an die Middleware (z. B. Erfolgsmeldung, Fehlercode).
Beispiele für Dokumentationsdateien:
- KPI.pdf / api-kpi.yaml
- Taskboard.pdf / api-taskboard.yaml
- Deviation.pdf / api-deviation.yaml
- Countermeasure.pdf / api-countermeasure.yaml
- List.pdf / api-list.yaml
- Processboard.pdf / api-processboard.yaml
ℹ️ Hinweis:
-
Kein API-Zugriff von ValueStreamer auf externe Systeme
-
Nur JSON wird als Datenformat unterstützt (kein XML)
📌 Technische Hinweise
-
Alle API-Zugriffe erfordern HTTP Basic Auth
-
API ist modular – Endpunkte sind nach Themen (KPIs, Aufgaben, Abweichungen, etc.) gruppiert
-
Keine Event-basierten Trigger oder Webhooks
-
Nutzung ohne Middleware ist technisch möglich, aber nicht für komplexe Szenarien empfohlen
✨ Tipps & Best Practices
-
Beginnen Sie mit einem GET-Test in Postman, um den API-Zugriff zu verifizieren
-
Achten Sie auf konsistente Feldbenennungen, besonders bei Custom-Feldern
-
Verwenden Sie die YAML-Dateien für die automatische Client-Code-Generierung
-
Führen Sie Integrationstests in einer Testumgebung durch, bevor Sie produktiv gehen
-
Implementieren Sie ein Logging in der Middleware, um API-Fehler frühzeitig zu erkennen
❓ FAQ
Wird automatisch mit ERP- oder MES-Systemen synchronisiert?
Nein, die Anbindung erfolgt ausschließlich über Middleware oder andere Integrationslösungen.
Kann ich ohne Middleware direkt auf die API zugreifen?
Ja, z. B. über Postman oder eigene Skripte. Für produktiven Betrieb wird Middleware empfohlen.
Gibt es Webhooks oder Event-basierte Trigger von ValueStreamer?
Nein, die REST API ist rein passiv.
Wo finde ich die API-Spezifikationen (YAML & PDF)?
→ Im Artikel 📚 API-Dokumentationen & YAML-Dateien