API-Übersicht

Die Mirox-Plattform stellt eine REST-API bereit, mit der Sie Anlagendaten, Automatisierung und Reporting in Ihre eigenen Systeme und Arbeitsabläufe integrieren können. Alles, was die Weboberfläche tut, basiert auf denselben öffentlichen Endpunkten, sodass Sie die Plattform programmatisch steuern können.

Interaktive Dokumentation

Die vollständige API-Spezifikation wird live aus der laufenden Plattform generiert und steht in zwei interaktiven Ansichten zur Verfügung:

Swagger UI unter /docs — eine interaktive Referenz mit integriertem Request-Builder, um Aufrufe direkt im Browser auszuprobieren.
ReDoc unter /redoc — dieselbe Spezifikation in einem für Lesen und Navigation optimierten Layout.

Beide Ansichten lassen Sie jeden verfügbaren Endpunkt mit seinen Parametern, dem Request-Body und dem Antwortformat erkunden. Sie sind die maßgebliche, stets aktuelle Referenz dafür, was die API leisten kann.

Wie die API organisiert ist

API-Endpunkte sind danach gruppiert, worauf sie sich beziehen, und jeder Pfad ist versioniert (zum Beispiel /v1/...). Häufige Bereiche sind:

Anlagen, Portfolios und Komponenten — lesen und verwalten Sie Ihre überwachten Standorte und deren Struktur.
Metriken und Datenexport — exportieren Sie jede Metrik als Zeitreihe, als CSV oder mit format=json als JSON, und definieren Sie eigene Metriken.
Ereignisse, Tickets und Reports — rufen Sie maschinell erkannte Signale, manuelle Folgearbeiten und generierte Reports ab.
Organisation, Kooperationen und Zugriff — verwalten Sie Mitglieder, Freigaben und Integrationstoken.

Der Zugriff auf jeden Endpunkt wird durch Ihre Rolle und Berechtigungen geregelt. Ein Aufruf gibt nur die Anlagen und Daten zurück, die Sie sehen dürfen, sodass die API dieselben Zugriffsregeln durchsetzt wie die Oberfläche.

Nicht alles ist in /docs aufgeführt

Einige Routengruppen sind absichtlich aus der veröffentlichten Spezifikation ausgeblendet, sodass sie zwar funktionieren, aber nicht in /docs oder /redoc erscheinen:

Administrative Endpunkte — Funktionen zur Plattformadministration, die Mirox-Mitarbeitern vorbehalten sind.
Gerätezuweisungs-Routen (/v1/device).

Wenn Sie eine dieser Routen anbinden möchten, wenden Sie sich für Unterstützung an den Mirox-Support.

Zeitreihendaten

Verwenden Sie für Zeitreihendaten die Metric-Export-API. Sie exportiert jede Metrik der Sammlung — Anlagen-, Komponenten-, Sensor-, Turbinen- und Batterieebene sowie die Metriken Ihrer Organisation — in Schrittweiten von 1 Minute bis zu einem Jahr. Eine GET-Anfrage antwortet mit CSV; format=json antwortet mit JSON.

Organisations-Metriken (MetricsQL)

Die unter Metriken definierten Metriken haben eine eigene Routengruppe, /v1/report/metric: Metriken auflisten, lesen, anlegen, ändern und löschen, POST /v1/report/metric/validate zum Prüfen eines Ausdrucks, POST /v1/report/metric/preview zum Ausführen gegen eine Anlage und GET /v1/report/metric/building-blocks für die Reihen und konfigurierten Werte, die ein Ausdruck lesen darf. Diese Metriken speisen die Berichte und den Metric Export gleichermaßen. MiroxQL-Formeln sind die berechneten Spalten des Legacy-Exports; ihre Routen bleiben verfügbar.

Erste Schritte

Um die API aufzurufen, authentifizieren Sie sich mit einem API-Token, das auf eine Berechtigungsgruppe beschränkt ist. Im Leitfaden API-Tokens erfahren Sie, wie Sie Tokens erstellen, einschränken und rotieren, und sie anschließend für Anfragen verwenden.

In Mirox öffnen

Erstellen und verwalten Sie Ihre Tokens unter Profil — öffnen Sie das Profilmenü (oben rechts) ▸ Profil und nutzen Sie den Bereich API-Tokens.

Ausführbaren, durchgängigen Integrationscode finden Sie im ausgearbeiteten Beispiel Externer Report-Generator.

API-Übersicht

Interaktive Dokumentation

Wie die API organisiert ist

Erste Schritte

Verwandte Funktionen