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

📡 Architektur & Nutzung der REST API im ValueStreamer

Dieser Artikel beschreibt die technische Architektur der ValueStreamer REST API, deren Integration in Kundenumgebungen und den Zugriff auf die zugehörige API-Dokumentation. Er zeigt, wie externe Systeme (z. B. ERP, MES) über eine Middleware angebunden werden, erläutert die unterstützten Schnittstellenformate und erklärt, wie die REST API im Alltag verwendet werden kann – inkl. Zugriff auf Dokumentationsdateien (PDF & YAML).

🔍 Inhalt

  • 🏗️ Systemarchitektur

  • 🔗 Funktionsweise der Middleware-Integration

  • 📚 API-Zugriff und Dokumentation

  • ✨ Tipps & Best Practices

  • ❓ FAQ

🛠️ So funktioniert’s

🏗️ 1. Systemarchitektur

  • Der ValueStreamer läuft in der Microsoft Azure Cloud.

  • Die Applikation ist modular aufgebaut:

    • Frontend und Backend sind über einen Azure Load Balancer verbunden.

    • Datenbankzugriffe erfolgen verschlüsselt (SSL) auf eine Azure MySQL-Datenbank.
      📸 Screenshot: Architekturübersicht

🔗 2. Integration externer Systeme über Middleware

  • Die REST-API agiert passiv – sie wartet auf Anfragen externer Systeme oder Middleware, stellt aber keine aktiven Push-/Pull-Mechanismen bereit.

Ablaufschritte:

  1. Kundensystem (z. B. MES, ERP) sendet Daten an die Middleware.

  2. Middleware verarbeitet, transformiert und mappt die Daten.

  3. Middleware überträgt die Daten im JSON-Format via REST API an ValueStreamer.

  4. Rückmeldungen erfolgen ebenfalls über die API.

ℹ️ Hinweise:

  • Kein API-Zugriff von ValueStreamer auf externe Systeme.

  • Nur JSON wird als Datenformat unterstützt (kein XML).

  • Alle API-Zugriffe erfordern eine Authentifizierung (API Key & Passwort).

📚 3. Zugriff auf API-Dokumentation

  • Die Endpunkte sind nach Modulen gruppiert (z. B. KPIs, Aufgaben, Abweichungen, Maßnahmen).

Beispiele für Dokumentationsdateien:

  • kpi-api_v2.pdf / api-kpi.yaml

  • task_api_v1.pdf / api-taskboard.yaml

  • deviation-api_v2.pdf / api-deviation.yaml

  • countermeasure_api.pdf / api-countermeasure.yaml

✨ Tipp:
Ziehen Sie die .yaml-Dateien direkt in Swagger UI oder Swagger Editor, um die API-Endpunkte interaktiv zu testen und automatisch Client-Code zu generieren.

✨ Tipps & Best Practices

  • 💡 Beginnen Sie mit einem einfachen GET-Test in Postman, um den API-Zugriff zu verifizieren.

  • 📌 Achten Sie auf konsistente Feldbenennungen bei der Verwendung von Custom-Feldern.

  • 📄 Verwenden Sie die .yaml-Dateien zur automatisierten Anbindung von Clients.

  • 🛠️ Implementieren Sie ein dediziertes Logging in der Middleware, um API-Fehler frühzeitig zu erkennen.

  • ✅ Testen Sie API-Integrationen vor dem Produktivbetrieb umfassend in einer sicheren Testumgebung.

❓ FAQ

Wird automatisch mit ERP- oder MES-Systemen synchronisiert?
➡️ Nein, die Anbindung erfolgt ausschließlich über eine Kunden-Middleware oder Dritttools.

Kann ich ohne Middleware direkt auf die API zugreifen?
➡️ Ja, z. B. über Postman oder eigene Skripte. Für den produktiven Einsatz wird jedoch der Einsatz einer Middleware empfohlen.

Gibt es Webhooks oder Event-basierte Trigger von ValueStreamer aus?
➡️ Nein, die REST API ist rein passiv. Ereignisgesteuerte Mechanismen sind aktuell nicht verfügbar.