mirror of
https://github.com/netzbegruenung/schaufenster.git
synced 2024-05-11 05:16:06 +02:00
.. | ||
api | ||
tests | ||
.gitignore | ||
Dockerfile | ||
Makefile | ||
README.md | ||
requirements.txt |
Schaufenster Service
Dies ist ein Webservice zur Erzeugung dynamischer Inhalte für Digital Signage Anwendungen.
Anwendungsbeispiel:
Auf einer digitalen Anzeigetafel soll stets aktuell der nächste Sitzungstermin angezeigt werden. Hierfür geben wir eine iCal-Kalender-URL an und bekommen dafür Titel und weitere Details der nächsten Termine in diesem Kalender zurück.
API
GET /events/
- Die nächsten Termine eines iCal Kalenders ausgeben
Request URL Parameter:
ical_url
: Adresse des iCal-Kalenders (erforderlich).num
: Maximale Anzahl der Termine, die ausgegeben werden.charset
: Zeichensatz der iCal-Quelle. Normalerweise wird der Zeichensatz angenommen, den der Webserver imContent-type
header angibt. Mit diesem Parameter kann der Wert des Servers überschrieben werden. Beispiel:charset=utf-8
.
Ausgabe:
[
{
"title": "Karfreitag",
"start": "2018-03-30",
"end": "2018-03-31"
},
...
]
Liste mit Terminen als JSON Array. Jeder Termin enthält:
title
: Titel des Terminsstart
: Start-Datum (oder Datum/Uhrzeit) des Terminsend
: (optional) Enddatum (oder Datum/Uhrzeit) des Termins
Beispiele:
Live Demo
Der Service ist erreichbar unter https://schaufenster-service.now.sh/events/