Labor-API: Unterschied zwischen den Versionen
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…“) |
Basti (Diskussion | Beiträge) (Status aktualisiert) |
||
| (3 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| + | {{Projekt | ||
| + | |kontakt = Basti | ||
| + | |status = abgeschlossen | ||
| + | |beschreibung = Sammelt und stellt Informationen rund ums Labor bereit | ||
| + | |interessenten = | ||
| + | }} | ||
Die '''Labor-API''' ist in Python (mit [http://flask.pocoo.org/ Flask]) geschrieben und läuft auf einem [http://gunicorn.org/ gunicorn-Server]. | Die '''Labor-API''' ist in Python (mit [http://flask.pocoo.org/ Flask]) geschrieben und läuft auf einem [http://gunicorn.org/ gunicorn-Server]. | ||
| Zeile 8: | Zeile 14: | ||
|return1=open, boolean, Türstatus | |return1=open, boolean, Türstatus | ||
|return2=since, integer, Unix Timestamp der letzten Aktualisierung | |return2=since, integer, Unix Timestamp der letzten Aktualisierung | ||
| + | }} | ||
| + | {{API-Methode | ||
| + | |name='''GET''' [https://freieslabor.org/api/room_archive/ /api/room_archive/] | ||
| + | |beschreibung=Gibt das [[Laborstatus]]-Archiv zurück. | ||
| + | |return1=open, boolean, Türstatus | ||
| + | |return2=timestamp, string, Zeitstempel im Format ISO 8601 | ||
}} | }} | ||
{{API-Methode | {{API-Methode | ||
| Zeile 36: | Zeile 48: | ||
[[Kategorie:Python]] | [[Kategorie:Python]] | ||
[[Category:Infrastruktur]] | [[Category:Infrastruktur]] | ||
| + | [[Kategorie:Dokumentation]] | ||
Aktuelle Version vom 5. Juni 2017, 13:10 Uhr
| Labor-API | |
|---|---|
| Beschreibung: | Sammelt und stellt Informationen rund ums Labor bereit |
| Kontakt: | Basti |
| Status: | abgeschlossen (Was heißt das?) |
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).
Inhaltsverzeichnis
GET /api/room/
Gibt den aktuellen Laborstatus und den Zeitpunkt der letzten Änderung zurück. (Bildrepräsentation: /api/room_image.png)
| Rückgabewerte: | Name | Typ | Beschreibung |
| open | boolean | Türstatus | |
| since | integer | Unix Timestamp der letzten Aktualisierung |
GET /api/room_archive/
Gibt das Laborstatus-Archiv zurück.
| Rückgabewerte: | Name | Typ | Beschreibung |
| open | boolean | Türstatus | |
| 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.
| Parameter: | Name | Typ | Beschreibung |
| open | boolean | Raumstatus |
| Rückgabewerte: | Name | Typ | Beschreibung |
| success | boolean | Erfolgsstatus | |
| status | string | Fehlermeldung (KANN verfügbar sein WENN success == false) |
Andere API-Inhalte
- /api/twitter/freieslabor.atom - Twitterfeed als Atom
- /api/twitter/freieslabor.atom/wikimarkup - Twitterfeed als Atom mit Links in Wiki-Syntax
- /api/twitter/freieslabor.atom/nolinks - Twitterfeed als Atom ohne HTML-Links
- /api/events_utc.ical - Kalender im ical-Format in UTC
