Die Fahrplan und Suchmaschinen-API

Die API ermöglicht ganz einfach das sichere und kontrollierte Abrufen der Suchergebnisse für externe System, Suchportale und Verzeichnisse.

Voraussetzungen

Damit man die Fahrten pollen kann, wird ein Token und die entsprechende URL benötigt, die man vom Accountinhaber erhält.

Parameter

Folgende Parameter die per GET der URL angehängt werden, stehen zur Verfügung

  • xml_token : der Token den Sie vom Accountinhaber für den Zugriff erhalten
  • datum : Das Datum im Unix Timestamp Format nach Lokalzeit, ab wann die Ergebnisse abgerufen werden sollen
  • datum_bis : Das Datum im Unix Timestamp Format nach Lokalzeit, bis wann die Ergebnisse dargestellt werden sollen. Maximaler Zeitraum beträgt 1 Monat
  • max_days : Alternative zu datum_bis. Anzahl der angezeigten Tage. Der maximale Zeitraum beträgt 31 Tage (1 Monat)
  • linie_region_id : Optional, wenn dieser Wert angegeben wird, dann wird das Suchergebnis auf diese Linienregion eingeschränkt
  • linie_typ_id : Optional, wenn dieser Wert angegeben wird, dann wird das Suchergebnis auf diesen Linientyp eingeschränkt
  • linie_id : Optional, wenn dieser Wert angegeben wird, wird nur diese Linie ausgegeben
  • station_id: Optional, wenn angegeben wird das Suchergebnis nur von dieser Abfahrtstation angezeigt
  • zielstation_id: Optional, wenn angegeben wird das Suchergebnis nur zu dieser Zielstation angezeigt
  • ressource_id: Optional, wenn angegeben wird das Suchergebnis nur mit der angegebenen Ressource angezeigt
  • personen_id: Optional, wenn angegeben wird das Suchergebnis mit der personen_id bestückt, die an anderer Stelle z.B. zum Vermerken der Provision wiederverwendet werden kann
  • kapazitaet: Optional, wenn angegeben wird das Suchergebnis mit der entsprechenden Fahrkapazität ausgegeben. Das Aktivieren dieser Option kostet Performance

Suchergebnis

Das Suchergebnis wird als JSON ausgeben und ist gruppiert in folgende Abschnitte:

  • Meta Informationen (meta): Datum der Erzeugung
  • Mandant-Informationen (shops): Informationen zum Mandant und der Ziel-URL
  • Stationen (stations): Die Verfügbaren Stationen in dem Array
  • Verbindungen (relations): Die Fahrtkombinationen mit Angabe des Standard-Preistyps (i.d.R. Erwachsene) und der Betreiber der Linie. Die Datumsangaben sind im Unix Timestamp

Übergabe der Felder aus der Linienverwaltung

Folgende Bezeichnungsfelder aus der Linienverwaltung werden übergeben

  • Linien-Bezeichnung: Bezeichnung(Internet)
  • Ressourcen-Bezeichnung: Bezeichnung
  • Preistyp-Bezeichnung: Bezeichnungsfeld aus Systemparametern Kunden - Preistyp
  • Ausstattung-Bezeichnung: Bezeichnungsfeld aus Systemparametern
  • Extra-Zusatz-Bezeichnung: Wenn in der Linienverwaltung das Feld in "Weitere Einstellungen - Extras- Zusätze - Abweichende Bezeichnung" ausgefüllt ist, wird dieses verwendet, ansonsten das Bezeichnungsfeld aus den Systemparametern

Einbindung Buchungsmaske

Die URL der Buchungsmaske wird im Suchergebnis im Abschnitt "shop", im Feld url ausgegeben, die Parameter werden als GET Variablen angehängt. Um die Buchungsmaske direkt mit dem gewählten Suchergebnis zu laden, bestehen folgende Parameter, die alle optional sind:

  • hafen_id : Abfahrtstation als Int-Wert, entspricht aus dem Suchergebnis "to"
  • zielhafen_id : Zielstation als Int-Wert, entspricht "from"
  • linie_id : Einschränkung der Fahrt auf eine bestimmte Linie, die linie_id entspricht im Abschnitt Verbindungen unter Sections dem Feld "tour"
  • hinfahrt_datum : Datum der Hinfahrt als Unix-Timestamp
  • anzeige_tage : Anzahl der Vorschau des Suchergenisses in Tagen
  • einfache_fahrt : true als String. Der Haken bei einfache Fahrt (nur Hinfahrt) ist vorausgewählt und es wird nach Auswahl der Hinfahrt direkt der nächste Schritt ausgeführt. Die Rückfahrt wird nicht mehr angeboten.Die Angabe ist optional
  • rueckfahrt_datum : Datum der Rückfahrt als Unix-Timestamp (optional)
  • vermittler_id : Die Provisionsempfänger-ID des anbindenden Portals, das der Linienanbieter in den eigenen Stammdaten angelegt hat

Beispiel Aufruf API

Aufruf der Schnittstelle aus der Onlinedemo
JSON anzeigen

Beispiel Buchungsmaske

Aufruf der Buchungsmaske aus der Onlinedemo
Buchungsmaske öffnen

Wegweiser