From 11d585caa8c702588e9e0e2ea6b6ad91799ad2b4 Mon Sep 17 00:00:00 2001 From: MaZderMind Date: Thu, 9 Apr 2015 15:47:55 +0200 Subject: Mention API in README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8b53ad8..a106aed 100644 --- a/README.md +++ b/README.md @@ -28,3 +28,10 @@ Die Gesamte Seite wird von der zentralen [config.php](config.php)-Datei gesteuer Für die Konferenztypische Gestaltung kann in der [main.less](assets/css/main.less) nach Wunsch ausgestaltet werden. Als Beispiel sei hier die Gestaltung für das [Easterhegg 2015](https://eh15.easterhegg.eu/site/) verlinkt: [d3c0e74](https://github.com/voc/streaming-website/commit/d3c0e74f459121c3e624c9b3b92d6ec6b39a3dbe) Üblicherweise machen wir für jede Veranstaltung einen `events/XXXX` branch auf, wobei XXXX das Acronym der Konferenz ist. + + +## JSON-API + +Unter der URL http://streaming.media.ccc.de/streams/v1.json bietet die Steaming-Webseite eine Übersicht über alle konfigurierten Räume und Streams in einem Maschienenlesbaren Format an. Dieses kann z.B. genutzt werden, um in den diversen Anwendungen die sich rund um das Konferenzgeschehen entwickelt haben Player und Links zu Liveübertragungen anzubieten. + +Wie die URL vermuten lässt, ist die API versionionert. Dies bedeutet, dass in der v1.json keine Felder *entfernt werden* oder ihre *bedeutung ändern* – es können aber durchaus *neue Felder* hinzukommen. Eine formalere Spezifikation des JSON-Formats ist tbd. -- cgit v1.2.3