From 645509be80db9e518d38df399fd194de7b4c1ca3 Mon Sep 17 00:00:00 2001 From: Birte Kristina Friesel Date: Wed, 6 Nov 2024 21:22:42 +0100 Subject: API description: most pages have JSON; document header --- templates/layouts/app.html.ep | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/templates/layouts/app.html.ep b/templates/layouts/app.html.ep index ce82662..7ff1cf7 100644 --- a/templates/layouts/app.html.ep +++ b/templates/layouts/app.html.ep @@ -278,24 +278,17 @@ Bitte eine Station aus der Liste auswählen DD.MM.[YYYY]-Format abgefragt werden, z.B. "ICE 921 (1.1.)" oder "ICE 921 @ 1.1.". Das Datum bezieht sich auf die geplante Abfahrtszeit am Startbahnhof der Zugfahrt. -
  • Die Parameter mode=json&version=3 - (alternativ https://dbf.finalrewind.org/Bahnhofsname.json?version=3) - bieten ein JSON-Interface für IRIS- und HAFAS-Abfahrten. - Die route-Elemente können zusätzlich - die Felder "isAdditional" oder "isCancelled" enthalten, der Rest sollte - selbsterklärend sein. Im Fehlerfall fehlt das "departures"-Element, - stattdessen wird ein "error"-Element mit Fehlermeldung zurückgegeben. - Bitte maximal 30 Anfragen pro Minute und insbesondere nur eine Anfrage +
  • Viele Seiten sind auch als JSON verfügbar, wahlweise mittels + Accept: application/json oder + durch .json in der URL. + HAFAS- und IRIS-Abfahrtstafeln liefern mit dem GET-Parameter version=3 eine stabile JSON-API. + Alle anderen Endpunkte (sowie Abfahrtstafeln mit version=raw) erlauben direkten Zugriff auf die serialisierten Travel::Status::DE::{EFA,HAFAS,IRIS}-Objekte ohne stabile API.
    • +
  • Bitte maximal 30 Anfragen pro Minute und insbesondere nur eine Anfrage pro Station und Minute – eine höhere Auflösung haben die Backenddaten ohnehin nicht.
  • Mit limit kann die Anzahl der angezeigten / im JSON enthaltenen Abfahrten eingeschränkt werden, z.B. limit=10 für die ersten zehn.
    • -
  • mode=json&version=raw - erlaubt direkten Zugriff auf die serialisierten Travel::Status::DE::{EFA,HAFAS,IRIS}-Objekte. - Hier gibt es keine stabile API.
    • -
  • Zugdetails sind ebenfalls per JSON verfügbar und ebenso ohne stabile API.
  • Dieser Dienst ist Open Source-Software und kann leicht auf eigenen Servern installiert werden. Automatisierte Crawler, die mehrere Dutzend Stationen pro Minute -- cgit v1.2.3