RufBusle/Entwickler
Dokumentation
API v1

RufBusle für Entwickler

Fahrplan, Fahrzeuge und tatsächlichen Fahrtbedarf maschinell abrufen — für Dienst- und Umlaufplanung, Fuhrparksysteme, Auswertungen und Auskunftsdienste.

SchnellstartOpenAPI-Spec (JSON)

Drei Schnittstellen

Sie unterscheiden sich nicht im Datenbestand, sondern darin, wer sie nutzen darf und wer wen anspricht.
ohne Anmeldung

Offene Fahrplandaten

Der GTFS(-Flex)-Feed einer Stadt. Frei abrufbar, für Auskunftssysteme, DELFI und die Mobilithek. Kostenlos, weil Veröffentlichungspflicht.
mit Schlüssel

REST-API

Betriebliche Daten unter /api/v1 — Bedarf, Fahrzeuge, Fahrplan. Lesend, paginiert, mit feingliedrigen Rechten.
wir rufen Sie an

Webhooks

Signierte Ereignisse an eine Adresse Ihrer Wahl, sobald etwas passiert. Erspart das Abfragen im Minutentakt.

REST-API und Webhooks gehören zum Enterprise-Tarif und müssen von der Stadt aktiv eingeschaltet werden. Der offene Feed nicht — er ist eine Meldepflicht und kein Zusatzprodukt.

Was möchten Sie erreichen?

Der schnellste Weg zur richtigen Schnittstelle führt über das Ziel, nicht über die Endpunktliste.

Fahrplandaten veröffentlichen

Kommune · Aufgabenträger

Auskunftssysteme, DELFI und die Mobilithek brauchen den Fahrplan als GTFS. Das ist eine Meldepflicht — der Feed ist deshalb kostenlos und ohne Schlüssel abrufbar.

  1. 1Im Stadt-Admin unter Einstellungen → Organisation den öffentlichen Feed freischalten.
  2. 2Die Feed-Adresse von der Datenangebot-Seite der Stadt kopieren.
  3. 3Adresse bei der Mobilithek bzw. beim zuständigen DELFI-Aufgabenträger hinterlegen.
Offene Fahrplandaten

Bedarf in die Dienst- und Umlaufplanung übernehmen

Verkehrsunternehmen · Disposition

Ein Rufbus fährt nur, wenn gebucht wurde. Wer Dienste und Umläufe in einem eigenen Planungssystem pflegt, braucht dafür beides: das Soll-Angebot und den tatsächlichen Bedarf.

  1. 1Einmalig Halte und Linien laden und im eigenen System als Stammdaten ablegen.
  2. 2Fahrten als Fahrplan-Vorlagen lesen — sie liefern Zeitlage und Verkehrstage.
  3. 3Buchungen für den geplanten Zeitraum abrufen und Fahrten ohne Buchung aussortieren.
BuchungenFahrtenHaltestellen

Auf Ereignisse reagieren statt zu pollen

Betreiber-IT

Wenn Ihr System sofort wissen soll, dass eine Buchung eingegangen oder storniert wurde, ist ein Minutentakt gegen die API der falsche Weg.

  1. 1Im Stadt-Admin eine HTTPS-Adresse hinterlegen und die gewünschten Ereignisse wählen.
  2. 2Das einmalig angezeigte Geheimnis speichern und jede Zustellung damit prüfen.
  3. 3Auf die Zustellung mit 2xx antworten und die Verarbeitung asynchron erledigen.
Webhooks

Fuhrpark abgleichen

Verkehrsunternehmen

Damit Fahrzeuge in beiden Systemen dasselbe bedeuten, braucht es einen gemeinsamen Schlüssel — nicht den Fahrzeugnamen.

  1. 1In RufBusle je Fahrzeug die ID aus Ihrem System als externe ID hinterlegen.
  2. 2Fahrzeuge über die API lesen und über die externe ID zuordnen.
  3. 3Kapazitäten gegenprüfen — sie steuern in RufBusle die Buchbarkeit.
Fahrzeuge

Auswertungen und Berichte bauen

Kommune · Controlling

Nachfrage, Auslastung und Storno-Quote lassen sich außerhalb von RufBusle auswerten — etwa im vorhandenen Berichtswesen der Verwaltung.

  1. 1Buchungen zeitraumweise abrufen und im eigenen Datenbestand fortschreiben.
  2. 2Über die Fahrt auf Linie und Zeitlage verknüpfen.
  3. 3Stornierte Buchungen getrennt ausweisen statt zu verwerfen.
BuchungenPersonenbezogene Daten

Buchung auf der eigenen Website anbieten

Kommune

Die Buchungsstrecke soll auf der Gemeinde-Website stehen statt auf einer eigenen Adresse — in den eigenen Farben und ohne dass Fahrgäste die Seite verlassen.

  1. 1Im Stadt-Admin unter „Erweiterungen" das Website-Widget installieren.
  2. 2Die Adresse der eigenen Website als erlaubte Domain eintragen.
  3. 3Den Code aus dem Konfigurator in die Website einfügen.
Buchungs-Widget

Was die API heute nicht kann

Damit Sie es nicht durch Ausprobieren herausfinden müssen.

Nur lesen

Alle Endpunkte sind lesend. Buchungen anlegen, Fahrten verschieben oder Zuweisungen ändern geht über die API nicht — das passiert im Stadt-Admin oder in der Fahrer-App.

Keine Echtzeit-Positionen

Es gibt keine Fahrzeugortung und folglich kein GTFS-Realtime und kein VDV 454. Fahrzeugdaten sind Stammdaten.

Keine Personendaten

Fahrer- und Nutzerkonten sind über die API grundsätzlich nicht abrufbar; Kontaktdaten von Fahrgästen nur mit eigens vergebenem Recht.

Kein Browser-Zugriff

Die API hat keine CORS-Freigabe und soll auch keine bekommen. Ein API-Schlüssel gehört auf einen Server, nicht in eine Webseite.

Alles auf einen Blick

Die Dokumentation lässt sich von vorn nach hinten lesen — oder gezielt anspringen.

Einstieg

  • Schnellstart — Vom Schlüssel zum ersten Aufruf in drei Schritten.
  • Authentifizierung & Rechte — API-Schlüssel, Scopes und warum es keinen Stadt-Parameter gibt.
  • Konventionen — Paginierung, Fehlerhülle, Rate-Limit und Versionierung — gleich für alle Endpunkte.

Schnittstellen

  • REST-API — Alle Endpunkte zum Lesen und zum Buchen, gruppiert nach Anwendungsfall, mit Feldern und Beispielantwort.
  • Webhooks — Ereignisse aus RufBusle empfangen statt zu pollen — mit signierter Zustellung und Wiederholungen.
  • Offene Fahrplandaten — Der freie GTFS(-Flex)-Feed einer Stadt für Auskunftssysteme, DELFI und die Mobilithek.
  • Plugins — Eigene Buchungskanäle und Erweiterungen bauen, die Städte mit expliziter Zustimmung installieren — inkl. Schreibzugriff auf Buchungen.
  • Buchungs-Widget — Buchung und Fahrplan auf der eigenen Gemeinde-Website einbetten — gestaltbar, barrierefrei, ohne Cookies.

Grundlagen

  • Personenbezogene Daten — Was die Schnittstellen über Fahrgäste preisgeben — und was bewusst nicht.
  • Änderungen — Was sich an der API geändert hat und was wir als Bruch behandeln.
  • Support & Kontakt — Wie Sie uns bei einer Anbindung erreichen und was wir dafür brauchen.

Die Beispiele in dieser Dokumentation verwenden https://rufbusle.de als Basis-Adresse. Betreibt eine Stadt eine eigene Domain, funktioniert die API auch dort.