Zu Content springen
Deutsch
Mehr Unterstützung
Kontakt
  • 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 sowie deren Integration in Kundenumgebungen. Er zeigt, wie externe Systeme (z. B. ERP, MES) über Middleware angebunden werden können, erläutert den Ablauf der Datenverarbeitung, stellt die unterstützten Schnittstellenformate vor und erklärt, wie die REST API im Alltag verwendet werden kann – inkl. Dokumentationszugang (PDFs und YAML-Dateien). Ziel ist es, einen vollständigen Überblick über die API-Nutzung im Kontext von ValueStreamer bereitzustellen.

🔍 Inhalt

  1. Systemarchitektur

  2. Funktionsweise der Middleware-Integration

  3. API-Zugriff und Dokumentation

  4. Hinweise zur Nutzung

  5. Tipps & Best Practices

  6. Nächste Schritte

  7. FAQ

  8. Weiterführende Artikel

🛠️ So funktioniert’s

1. Systemarchitektur
Der ValueStreamer läuft in der Microsoft Azure Cloud. Die Applikation ist modular aufgebaut in Frontend und Backend, verbunden über einen Azure Load Balancer. Datenbankzugriffe erfolgen verschlüsselt (SSL) auf eine Azure MySQL-Datenbank.

📸 Architekturübersicht

2. Integration externer Systeme über Middleware
Die REST-API des ValueStreamer agiert passiv – d.h. sie wartet auf Anfragen externer Tools oder Middleware, um Daten entgegenzunehmen oder bereitzustellen. Es erfolgt kein aktives Push/Pull seitens ValueStreamer.

📸 Ablauf Middleware → ValueStreamer API

Ablaufschritte:

  • Kundensystem (z. B. MES/ERP) sendet Daten an Middleware

  • Middleware verarbeitet, transformiert und mappt die Daten

  • Middleware sendet JSON via REST API an ValueStreamer

  • Rückmeldung erfolgt ebenfalls über die API

3. Zugriff auf API Dokumentation
Die Dokumentation aller REST API-Endpunkte (PDF + YAML) ist über ein eigenes Portal erreichbar. Die Endpunkte sind nach Modulen gruppiert (z. B. KPIs, Aufgaben, Abweichungen etc.).

📸 API-Dokumentationsübersicht

Typische Dokumente:

  • 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

ℹ️ Weitere Hinweise

  • ValueStreamer REST API unterstützt nur JSON (kein XML etc.)

  • Alle Zugriffe benötigen Authentifizierung (API Key & Passwort)

  • Kein API-Zugriff von ValueStreamer auf externe Systeme

  • .yaml-Dateien dienen als Vorlage für automatisierte Anbindung

  • Testzugriffe via Postman möglich

  • Livebetrieb über Middleware empfohlen

✨ Tipps & Best Practices

  • Nutze die .yaml-Dateien zur automatischen Generierung von Client-Code (z. B. OpenAPI Generator)

  • Beginne mit einem einfachen GET-Test über Postman

  • Achte auf konsistente Feldbenennungen bei Custom-Feldern

  • Setze ein dediziertes Logging in der Middleware ein, um API-Fehler rasch zu erkennen

🚀 Nächste Schritte

  • API-Zugangsinfos beim Systemadministrator anfordern

  • Verbindung zur Testinstanz aufbauen

  • Erste Abfrage (GET) gegen einen einfachen Endpunkt starten

  • API-Endpunkte für geplante Use Cases identifizieren

  • Anbindung produktiv nehmen

❓ FAQ

Wird automatisch mit ERP oder MES synchronisiert?
Nein, die Anbindung muss durch Kunden-Middleware oder Dritttools erfolgen.

Kann ich ohne Middleware direkt auf die API zugreifen?
Ja, technisch ist das z. B. mit Postman oder Skripten möglich – für produktive Szenarien ist Middleware empfohlen.

Gibt es Webhooks oder Event-basierte Trigger von ValueStreamer aus?
Nein. Die REST API ist rein passiv.

🔗 Weiterführende Artikel

  • API Beschreibung – KPIs

  • API Beschreibung – Aufgaben

  • API Beschreibung – Abweichungen

  • API Beschreibung – Maßnahmen