Watchmen REST API
Entdecken Sie die öffentliche Watchmen REST API, ihre Authentifizierungsmethoden, Basis-URL und verfügbaren Endpunktgruppen.
Überblick
Die Watchmen REST API ermöglicht authentifizierten Zugriff auf die in dieser Referenz dokumentierten öffentlichen Funktionen. Wählen Sie einen Endpunkt in der Navigation aus, um Parameter, Anfragebeispiele, Antwortschemas und den interaktiven Playground anzuzeigen.
Basis-URL
https://wm.novoai.de
Authentifizierung
Jede Anfrage muss eine der von der API unterstützten Authentifizierungsmethoden verwenden:
- Senden Sie ein JWT als
Authorization: Bearer <token>. - Senden Sie einen API-Zugriffsschlüssel als
X-API-KEY: <key>.
Speichern Sie API-Zugriffsschlüssel und JWTs nicht im clientseitigen Code, in der Versionsverwaltung oder in Protokollen.
Verfügbare Ressourcen
Die API-Referenz stellt derzeit die folgenden Endpunkte bereit. Wählen Sie einen Endpunkt aus, um Parameter, Anfragekörper, Beispiele, Antwortschemas und den interaktiven Playground anzuzeigen.
GET /v2/halls
Ruft alle Hallen ab, die dem Unternehmen des authentifizierten Benutzers zugeordnet sind.
GET /v2/halls/{id}
Ruft eine bestimmte Halle anhand ihrer eindeutigen ID ab.
GET /v2/machine
Ruft die Maschinen des Unternehmens ab und kann optional inaktive Maschinen einschließen.
GET /v2/timeline_reason
Ruft die Zeitachsen-Gründe zur Klassifizierung von Stillständen und Betriebsereignissen ab.
POST /v2/timeline/reason_assign
Weist einer Maschine einen Zeitachsen-Grund für ein aktuelles oder historisches Ereignis zu.
POST /v2/timeline/reason_preset
Legt einen Zeitachsen-Grund für eine aktuelle oder geplante Maschinenaktivität im Voraus fest.
POST /v2/analytics/day
Ruft umfassende Maschinenanalysen für einen einzelnen Kalendertag ab.
Jeder Link öffnet die zugehörige Referenzseite für den aufrufbaren API-Endpunkt.