Labor-API

Version vom 25. Juni 2024, 20:17 Uhr von Basti (Diskussion | Beiträge)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

Die Labor-API ist in Python (mit Flask) geschrieben und läuft auf einem gunicorn-Server: https://github.com/freieslabor/flask-rest-api

Das Ausgabeformat ist momentan auf JSON beschränkt. Die schreibenden Methoden benötigen API-User und API-Key zur Authentifizierung (Nachricht an Basti).

GET /api/room/ Gibt den aktuellen Laborstatus und den Zeitpunkt der letzten Änderung zurück. (Bildrepräsentation: /api/room_image.png) return1=open, boolean, Türstatus return2=since, integer, Unix Timestamp der letzten Aktualisierung

GET /api/room_archive/ Gibt das Laborstatus-Archiv zurück. return1=open, boolean, Türstatus return2=timestamp, string, Zeitstempel im Format ISO 8601

GET /api/info/ bzw. /api/room_extended/ Stellt allgemeine Informationen (inkl. Laborstatus) zur Verfügung. API Version: 0.13.

Siehe Spezifikation.

Schreibende Methoden

POST' /api/room/ (Authentifizierung erforderlich) Setzt den Raumstatus. param1=open, boolean, Raumstatus return1=success, boolean, Erfolgsstatus return2=status, string, Fehlermeldung (KANN verfügbar sein WENN success == false)