Änderungen
Was sich an den Schnittstellen geändert hat — und woran Sie erkennen, ob eine Änderung Ihren Client betrifft.
Was wir als Bruch behandeln
Damit Sie wissen, worauf Sie sich verlassen können.
Jederzeit möglich, ohne Ankündigung: neue optionale Felder in Antworten, neue Endpunkte, neue Ereignistypen, neue Werte in bestehenden Statusfeldern. Ihr Client muss unbekannte Felder und unbekannte Werte deshalb überstehen, statt an ihnen zu scheitern.
Nur mit neuer Version im Pfad: ein Feld entfernen, seinen Typ ändern, seine Bedeutung umdeuten, ein optionales Feld verpflichtend machen oder einen Endpunkt abschaffen. Die alte Version bleibt dann zunächst erreichbar und antwortet mit einem Deprecation-Header.
Verlauf
Einbettbares Widget
- NeuBuchung und Fahrplan lassen sich über /embed/v1.js als <rufbusle-booking> und <rufbusle-timetable> auf der eigenen Website einbinden.
- NeuBuchungen aus dem Widget tragen in Webhooks und in der API die Herkunft sourcePluginSlug = web-widget.
API v1 eingeführt
- NeuLesende REST-API unter /api/v1 mit Schlüssel-Authentifizierung, Scopes und Cursor-Paginierung.
- NeuEndpunkte für Verbindungstest, Haltestellen, Linien, Fahrten, Buchungen, Fahrzeuge und den GTFS-Feed.
- NeuSignierte Webhooks für Buchungsereignisse und Fahrplanänderungen, mit Wiederholungen.
- NeuOpenAPI-3.1-Beschreibung unter /api/v1/openapi.json, erzeugt aus denselben Schemas wie die Implementierung.
- Neuattributions.txt im GTFS-Feed, sobald eine Stadt Lizenz und Namensnennung hinterlegt hat.