mirror of
https://github.com/netzbegruenung/schaufenster.git
synced 2024-05-04 10:13:40 +02:00
2.7 KiB
2.7 KiB
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 /feed/
- Beiträge eines RSS- oder Atom Feed ausgeben
Request URL Parameter:
url
: URL des Feednum
: Anzahl der Einträge, die zurück gegeben werden sollen (default: 1)
Ausgabe:
{
"meta": {
"title": "Die Grünen Rösrath",
"link": "http://gruene-roesrath.de",
"description": "",
"published": null
},
"items": [
{
"title": "Informationsveranstaltung zur Start-/Landebahnsanierung am Flughafen",
"summary": "Die Flughafen Köln/Bonn GmbH informiert am 1. März über die anstehende Sanierung der großen Start-...",
"link": "http://gruene-roesrath.de/startseite/news-detailansicht/article/informationsveranstaltung_zur_start_landebahnsanierung_am_flughafen/",
"published": "2018-02-19T20:15:00"
}
]
}
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/
GET /luftdaten.info/v1/sensor/{sensor_id}/
- Aktuelle Messwerte eines luftdaten.info Sensors ausgeben
Mit dieser Methode können Feinstaub-Messwerte eines luftdaten.info Sensors abgerufen werden.
Beispiel: