schaufenster/service
Marian Steinbach 5c012d19f1 Add Kubernetes manifests 2020-08-03 21:43:19 +02:00
..
api Upadate service 2020-08-03 21:13:50 +02:00
kubernetes Add Kubernetes manifests 2020-08-03 21:43:19 +02:00
tests Add feed endpoint 2018-03-05 22:28:37 +01:00
.dockerignore Upadate service 2020-08-03 21:13:50 +02:00
.gitignore First version of an iCal calender service 2018-02-04 13:20:24 +01:00
Dockerfile Update to Alpine 12 2020-08-03 21:21:43 +02:00
Makefile Update to Alpine 12 2020-08-03 21:21:43 +02:00
README.md Add feed endpoint 2018-03-05 22:28:37 +01:00
requirements.txt Merge branch 'master' of https://github.com/netzbegruenung/schaufenster 2020-08-03 21:15:19 +02:00

README.md

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 Feed
  • num: 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 im Content-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 Termins
  • start: Start-Datum (oder Datum/Uhrzeit) des Termins
  • end: (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: