📡 Architecture & Usage of the REST API in ValueStreamer
This article explains the technical architecture of the ValueStreamer REST API, its integration into customer environments, and how to access the corresponding API documentation. It demonstrates how external systems (e.g., ERP, MES) are connected via middleware, describes the supported interface formats, and explains how the REST API can be used in daily operations – including access to documentation files (PDF & YAML).
🔍 Content
-
System Architecture
-
How Middleware Integration Works
-
API Access and Documentation
-
Tips & Best Practices
-
FAQ
🛠️ How it works
🏗️ System Architecture
-
The ValueStreamer runs in the Microsoft Azure Cloud.
-
The application is modular:
-
Database access is encrypted (SSL) to an Azure MySQL database.
-
📸 Screenshot: Architecture overview
(Directly place the original screenshot here:
architecture-overview)
-
🔗 Integration of External Systems via Middleware
-
The REST API acts passively – it waits for requests from external systems or middleware but does not provide active push/pull mechanisms.
Process steps:
-
The customer's system (e.g., MES, ERP) sends data to the middleware.
-
The middleware processes, transforms, and maps the data.
-
The middleware transmits the data in JSON format via REST API to ValueStreamer.
-
Responses are also provided via the API.
ℹ️ Note:
-
There is no API access from ValueStreamer to external systems.
-
Only JSON is supported as data format (no XML).
-
All API accesses require authentication (“HTTP Basic Auth”).
📚 API Access and Documentation
-
Endpoints are grouped by module (e.g., KPIs, Tasks, Deviations, Countermeasures).
Sample documentation files:
✨ Tip:
You can upload the .yaml files directly into Swagger UI or Swagger Editor to test API endpoints interactively and auto-generate client code.
✨ Tips & Best Practices
-
💡 Start with a simple GET test in Postman to verify API access.
-
📌 Ensure consistent field naming when using custom fields.
-
📄 Use the .yaml files for automated client integration.
-
🛠️ Implement dedicated logging in the middleware to detect API errors early.
-
✅ Always test API integrations thoroughly in a secure test environment before going live.
❓ FAQ
Does it synchronize automatically with ERP or MES systems?
No, the integration is done exclusively via customer middleware or third-party tools.
Can I access the API directly without middleware?
Yes, for example via Postman or custom scripts. However, for productive use the use of middleware is recommended.
Are there webhooks or event-based triggers from ValueStreamer?
No, the REST API is purely passive. Event-driven mechanisms are currently not available.