REST-API
| REST-API | |
|---|---|
| Zustandslose API, die Infos rund um den Hickerspace bereitstellt. | |
| Status | Läuft |
| OrganisatorIn | Basti |
| InteressentInnen | |
| Version | 0.2 |
| Download:
Download (extern) | |
Die Hicker-REST-API stellt einige Informationen über Wiki und Multi-User Chat zur Verfügung.
Alle Daten können ohne Authentifizierung via HTTP-GET abgerufen werden. Das Ausgabeformat ist momentan auf JSON beschränkt.
Inhaltsverzeichnis |
/api/wiki/ping/
Löscht den Wiki-Cache, insbesondere aber den RSS-Cache (erfolgt in festen Intervallen auch automatisch).
| Rückgabewerte: | Name | Typ | Beschreibung |
| success | boolean | Status der Operation |
/api/wiki/new/
Neueste Wiki-Artikel in Listenform.
| Rückgabewerte: | Name | Typ | Beschreibung |
| title | string | Titel des Wiki-Artikels | |
| author | string | Name des Autors | |
| description | string | HTML-Link zum Artikel kombiniert mit dem Autor | |
| link | string | Link zum Artikel | |
| pubDate | string | Datum und Uhrzeit des Erstellungszeitpunkts | |
| timestamp | integer | UNIX-Timestamp des Erstellungszeitpunkts |
/api/wiki/updated/
Zuletzt aktualisierte Wiki-Artikel in Listenform.
| Rückgabewerte: | Name | Typ | Beschreibung |
| title | string | Titel des Wiki-Artikels | |
| author | string | Name des Autors | |
| description | string | HTML-Link zum Artikel kombiniert mit dem Autor | |
| link | string | Link zum Artikel | |
| pubDate | string | Datum und Uhrzeit des Erstellungszeitpunkts | |
| timestamp | integer | UNIX-Timestamp des Erstellungszeitpunkts |
/api/wiki/userspace/
Zuletzt erstellte oder aktualisierte Wiki-Artikel im Userspace in Listenform.
| Rückgabewerte: | Name | Typ | Beschreibung |
| title | string | Titel des Wiki-Artikels | |
| author | string | Name des Autors | |
| description | string | HTML-Link zum Artikel kombiniert mit dem Autor | |
| link | string | Link zum Artikel | |
| pubDate | string | Datum und Uhrzeit des Erstellungszeitpunkts | |
| timestamp | integer | UNIX-Timestamp des Erstellungszeitpunkts |
/api/muc/
Stellt Informationen über den Multi-User Chat zur Verfügung (die alle zwei Minuten aktualisiert werden).
| Rückgabewerte: | Name | Typ | Beschreibung |
| botOnline | boolean | Status des Hickerbots | |
| mucUsers | integer | Anzahl der Nutzer im Multi-User Chat (ohne den Hickerbot) |
/api/room/
Gibt den aktuellen Raumstatus und den Zeitpunkt der letzten Änderung zurück.
| Rückgabewerte: | Name | Typ | Beschreibung |
| roomStatus | string | Status auf Englisch (open/closed) | |
| since | integer | Timestamp des letzten Änderungszeitpunkts |
/api/info/
Stellt allgemeine Informationen (inkl. Raumstatus) zur Verfügung (Spezifikation).
| Rückgabewerte: | Name | Typ | Beschreibung |
| api | string | SpaceAPI Versionsnummer | |
| space | string | Name unseres Hackerspaces | |
| url | string | URL zu unserer Website | |
| icon | assoziatives Array | Icons für offenen/geschlossenen Space | |
| → open | string | URL zum Logo für offenen Space | |
| → closed | string | URL zum Logo für geschlossenen Space | |
| address | string | Adresse | |
| contact | assoziatives Array | Kommunikationsmethoden | |
| → irc | string | IRC-Kontakt in der Form "irc://<host>[:<port>]/#<channel>" | |
| string | Twitter-Kontakt in der Form "@<twitteruser>" | ||
| → jabber | string | Jabber Multi-User-Chat-Raum | |
| logo | string | URL zum Logo | |
| open | boolean | true wenn der Raum offen ist sonst false (siehe auch Raumstatus) | |
| lastchange | long int | Zeitpunkt der letzten Statusänderung als UNIX Timestamp | |
| lat | float | Breitengrad des Spaces | |
| lon | float | Längengrad des Spaces | |
| feeds | Liste assoziativer Arrays | verschiedene Feeds | |
| → name | string | Name des Feeds | |
| → type | string | MIME-Type des Feeds | |
| → url | string | URL zum Feed |
