Skip to content
English
More support
Contact us
  • There are no suggestions because the search field is empty.

📡 Architecture & Usage of the REST API in ValueStreamer

This article describes the technical architecture of the ValueStreamer REST API, its integration into customer environments, and how to access the related API documentation. It explains how external systems (e.g., ERP, MES) are connected via middleware, outlines the supported interface formats, and shows how the REST API can be used in daily operations – including access to documentation files (PDF & YAML).

🔍 Contents

  • Prerequisites

  • System Architecture

  • How Middleware Integration Works

  • Technical Notes

  • Tips & Best Practices

  • FAQ

✅ Prerequisites

  • 🔐 API access credentials (username + password for HTTP Basic Auth)

  • 🌐 Base URL: https://api-<tenant>.valuestreamer.de/api/

  • 📄 API specifications (PDF & YAML) – see 📚 API Documentation & YAML files for download

  • 💻 A suitable API testing tool (e.g., Postman, Swagger Editor) or middleware

🏗️ System Architecture

ValueStreamer runs in the Microsoft Azure Cloud and has a modular structure:

  • Frontend: Browser-based user interface

  • Backend: REST API as the central interface

  • Database: Azure MySQL (SSL-encrypted)

  • Authentication: HTTP Basic Auth with username & password

🔗 How Middleware Integration Works

The REST API is passive – it waits for requests and does not perform active push/pull operations.

Typical integration flow:

  1. The customer system (e.g., MES, ERP) sends data to the middleware.

  2. The middleware processes, transforms, and maps the data.

  3. The middleware transmits the data in JSON format via the REST API to ValueStreamer.

  4. The API responds to the middleware (e.g., success message, error code).

Examples of documentation files:

ℹ️ Note:

  • No API access from ValueStreamer to external systems

  • Only JSON is supported as a data format (no XML)

📌 Technical Notes

  • All API access requires HTTP Basic Auth

  • The API is modular – endpoints are grouped by topic (KPIs, tasks, deviations, etc.)

  • No event-based triggers or webhooks

  • Use without middleware is technically possible but not recommended for complex scenarios

✨ Tips & Best Practices

  • Start with a GET test in Postman to verify API access

  • Ensure consistent field naming, especially for custom fields

  • Use the YAML files for automatic client code generation

  • Perform integration testing in a test environment before going live

  • Implement logging in the middleware to detect API errors early

❓ FAQ

Does ValueStreamer automatically synchronize with ERP or MES systems?
→ No, integration is only via middleware or other integration solutions.

Can I access the API directly without middleware?
→ Yes, e.g., via Postman or custom scripts. For production use, middleware is recommended.

Are there webhooks or event-based triggers from ValueStreamer?
→ No, the REST API is purely passive.

Where can I find the API specifications (YAML & PDF)?
→ In the article 📚 API Documentation & YAML Files.