RufBusle/Entwickler
Dokumentation

REST-API

Alle Endpunkte sind lesend und liefern JSON. Jeder hat eine eigene Seite mit Feldern, Beispielantwort und den Fallstricken, die man sonst erst beim zweiten Versuch findet.

Basis-Adresse
https://rufbusle.de/api/v1

Einstieg

Prüft Schlüssel, Stadt und Rechte — der erste Aufruf jeder Integration.
GET/api/v1/meVerbindungstestohne Scope

Liefert Stadt und gewährte Rechte des verwendeten Schlüssels. Erster Aufruf jeder Integration.

Fahrplan & Netz

Das Angebot: welche Halte, Linien und Fahrten es gibt. Ändert sich selten, gut cachebar.
GET/api/v1/stopsHaltestellenread:schedule

Haltestellen und Bedienzonen der aktiven Fahrpläne, inklusive DHID zur Zuordnung zum deutschlandweiten Haltestellenkatalog.

GET/api/v1/linesLinienread:schedule

Linien der aktiven Fahrpläne, entsprechend GTFS routes.

GET/api/v1/tripsFahrtenread:schedule

Fahrten als Fahrplan-Vorlagen inklusive Halte-Zeiten und Verkehrstagen — nicht als Einzeltermine. Konkrete Termine ergeben sich aus serviceDays.

GET/api/v1/feed/gtfs.zipGTFS-Feedread:schedule

Derselbe GTFS(-Flex)-Feed wie der öffentliche Stadt-Feed, nur schlüsselgeschützt. Unterstützt ETag/If-None-Match.

Bedarf & Betrieb

Was tatsächlich gebucht wurde — die Grundlage für Dienst-, Umlauf- und Abrechnungsplanung.
GET/api/v1/bookingsBuchungenread:bookings

Der tatsächliche Bedarf. Standardmäßig ohne personenbezogene Angaben; die Telefonnummer erscheint nur mit dem zusätzlichen Scope read:bookings:pii und fehlt sonst vollständig.

GET/api/v1/bookingsBuchung anlegenwrite:bookings

Legt eine Buchung im Namen eines Fahrgasts an (Gast-Buchung). Der Idempotency-Key-Header ist Pflicht — Wiederholungen mit demselben Key liefern dieselbe Buchung (200 statt 201) und buchen nie doppelt.

GET/api/v1/bookings/{id}/cancelBuchung stornierenwrite:bookings

Storniert eine Buchung der Stadt per ID. Idempotent: eine bereits stornierte Buchung antwortet 200 mit unverändertem Zustand; abgeschlossene Fahrten sind endgültig (409).

Fuhrpark

Fahrzeug-Stammdaten für den Abgleich mit einem führenden Fremdsystem.
GET/api/v1/vehiclesFahrzeugeread:vehicles

Fahrzeug-Stammdaten inklusive Kennzeichen und externalId — der Schlüssel für den Abgleich mit einem Fuhrparksystem.

Maschinenlesbare Beschreibung

Für Client-Generatoren und API-Werkzeuge.

Die vollständige OpenAPI-3.1-Beschreibung steht unter /api/v1/openapi.json und wird aus denselben Schemas erzeugt, gegen die wir zur Laufzeit validieren. Sie kann der Implementierung also nicht davonlaufen.

Client erzeugen (Beispiel)Shell
curl -sS https://rufbusle.de/api/v1/openapi.json -o rufbusle.json

npx @openapitools/openapi-generator-cli generate \
  -i rufbusle.json -g typescript-fetch -o ./src/generated/rufbusle