APIs and AI integration
This chapter is for developers and integrators. It describes the REST APIs and the MCP servers of the Smart Operations Toolkit. Use them to synchronize data with other systems, to build reports and to connect your own AI agents.
To send data from machines, see Connecting machines.
Typical integrations
| Use case | APIs |
|---|---|
Connect a machine |
Master data API (set up the device), machine data API (send data). See Step-by-step: connecting a machine. |
Synchronize devices from another system |
Master data API: create and update devices, device types and measuring points; use the technical ID to match devices. |
Use measured values in a report or dashboard |
Master data API (find the device ID), Measured values, events and rules API. |
Analyze process data in another tool |
Process data API: export as CSV or as complete OPP messages in JSON. |
Send emails from your own application |
Email notification API: create a template, publish notification requests. |
Connect your own AI agent |
API reference
The reference pages show all endpoints of an API with their parameters, request and response bodies. They are generated from the OpenAPI specifications of the current version.
| API | Reference |
|---|---|
Master data |
|
Measured values, events and rules |
|
Process data |
|
Email notifications |
|
User settings |
|
Machine data |
Measured values, events and rules API
Read measured values and events, manage rules.
APIs und KI-Integration
Dieses Kapitel richtet sich an Entwickler und Integratoren. Es beschreibt die REST-APIs und die MCP-Server des Smart Operations Toolkit. Sie dienen dazu, Daten mit anderen Systemen zu synchronisieren, Berichte zu erstellen und eigene KI-Agenten anzubinden.
Daten von Maschinen senden: siehe Maschinen anbinden.
Typische Integrationen
| Anwendungsfall | APIs |
|---|---|
Maschine anbinden |
Stammdaten-API (Gerät einrichten), Maschinendaten-API (Daten senden). Siehe Schritt für Schritt: Maschine anbinden. |
Geräte aus einem anderen System synchronisieren |
Stammdaten-API: Geräte, Gerätetypen und Messpunkte anlegen und aktualisieren; Geräte über die technische ID abgleichen. |
Messwerte in einem Bericht oder Dashboard verwenden |
Stammdaten-API (Geräte-ID ermitteln), API für Messwerte, Ereignisse und Regeln. |
Prozessdaten in einem anderen Werkzeug analysieren |
Prozessdaten-API: Export als CSV oder als vollständige OPP-Nachrichten in JSON. |
E-Mails aus einer eigenen Anwendung senden |
API für E-Mail-Benachrichtigungen: Vorlage anlegen, Benachrichtigungsanfragen veröffentlichen. |
Eigenen KI-Agenten anbinden |
API-Referenz
Die Referenzseiten zeigen alle Endpunkte einer API mit ihren Parametern, Anfragen und Antworten. Sie werden aus den OpenAPI-Spezifikationen der aktuellen Version erzeugt.
| API | Referenz |
|---|---|
Stammdaten |
|
Messwerte, Ereignisse und Regeln |
|
Prozessdaten |
|
E-Mail-Benachrichtigungen |
|
Benutzereinstellungen |
|
Maschinendaten |
API für Messwerte, Ereignisse und Regeln
Messwerte und Ereignisse lesen, Regeln verwalten.
API für E-Mail-Benachrichtigungen
Vorlagen verwalten und E-Mail-Benachrichtigungen anfordern.
API für Benutzereinstellungen
Anmeldung im Browser und Einstellungen des Benutzers.