Labor-API

Version vom 8. April 2015, 22:28 Uhr von Basti (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „Die '''Labor-API''' ist in Python (mit [http://flask.pocoo.org/ Flask]) geschrieben und läuft auf einem [http://gunicorn.org/ gunicorn-Server]. Das Ausgabefo…“)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Die Labor-API ist in Python (mit Flask) geschrieben und läuft auf einem gunicorn-Server.

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)

Rückgabewerte: NameTypBeschreibung
open boolean Türstatus
since integer Unix Timestamp der letzten Aktualisierung

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.

Parameter: NameTypBeschreibung
open boolean Raumstatus
Rückgabewerte: NameTypBeschreibung
success boolean Erfolgsstatus
status string Fehlermeldung (KANN verfügbar sein WENN success == false)

Andere API-Inhalte