Einführung

Diese Deeplink Dokumentation bezieht sich ausschließlich auf die Evolution IBE 3.0 von der Firma traffics.

Die Dokumentation dient dem Zweck eigene Deeplinks zu erstellen bzw. vorhandene Deeplink anpassen zu können.

Alle hier beschriebenen Beispiele funktionieren ausschließlich mit der Evolution IBE 3.0 der Firma traffics.

Technische Einführung

Die Evolution IBE 3.0 ist eine Single-Page applictaion (SPA) und wird über fest definiert URLs aufgerufen. Such- oder auch Filterparameter werden als GET-Parameter an diese URLs angehangen.

Beispiel für die Regionsliste der IBE:

/pauschalreise/regionen?minCategory=3&sortBy=quality&searchDate=041119,181119,7&adults=2
/hotel/regionen?minCategory=3&sortBy=quality&searchDate=041119,181119,7&adults=2
/flug/regionen?minCategory=3&sortBy=quality&searchDate=041119,181119,7&adults=2
/oneway/regionen?minCategory=3&sortBy=quality&searchDate=041119,181119,0&adults=2

Beispiel für die Hotelliste der IBE:

/pauschalreise/hotels?regionList=133&destinationName=Mallorca&minCategory=3&searchDate=041119,181119,7&adults=2&sortBy=price
/hotel/hotels?regionList=133&destinationName=Mallorca&minCategory=3&searchDate=041119,181119,7&adults=2&sortBy=price

Basis-URL

Ihre AusgangsURL bzw. Basis-Url hat das Format {{ book.baseUrl }}

Der Platzhalter [cfg] entspricht Ihrer Lizenznummer und muss mit dieser ersetzt werden, welche Sie in Ihren Zugangsdaten, welche Ihnen zugeschickt wurden, finden.

Die Basis-URL sollte anschließend zum Beispiel so aussehen https://ibe.traffics.de/1000000010000000.

Einstiegspfade in die IBE

Es gibt zur Zeit vier verschiedene Einstiegspfade in die IBE bzw. IBE-Strecken:

• Pauschalstrecke mit Pauschalangeboten, bestehend aus Flug + Hotelangeboten
• Hotelstrecke mit Hotelangeboten
• Flugstrecke mit Hin- und Rückflug
• Flugstrecke nur mit Hinflug

Der Platzhalter [cfg] muss mit Ihrer traffics Lizenznummer ersetzt werden.

Schritte durch die IBE

Die IBE besteht aus insgesamt 5 Schritten

• Regionen
• Hotels (bei Pauschal und Hotel)
• Angebote
• Buchen
• Gebucht

Regionen

Das ist der ursprüngliche Einstiegspunkt in jede IBE. Es werden in diesem Schritt die einzelnen Regionen als Liste aufgelistet und bei Klick auf eine Region, die dazugehörigen Unterregionen.

Der Platzhalter [cfg] muss mit Ihrer traffics Lizenznummer ersetzt werden.

Hotels

Es werden in diesem Schritt alle Hotels als Liste dargestellt, welche auf die Suchparameter hin gefunden wurden.

Der Platzhalter [cfg] muss mit Ihrer traffics Lizenznummer ersetzt werden.

Angebote

Es werden in diesem Schritt alle Preise passend zu einem Angebot als Liste dargestellt, welches auf die Suchparameter hin gefunden wurde.

Der Platzhalter [cfg] muss mit Ihrer traffics Lizenznummer ersetzt werden.

Buchen

In diesem Schritt findet die Buchung eines Angebotes in einem mehrstufigen Prozess statt.

Der Platzhalter [cfg] muss mit Ihrer traffics Lizenznummer ersetzt werden.

Gebucht

In diesem Schritt wurde die Buchung abgeschlossen und der User auf eine Übersichtsseite weitergeleitet nach einer erfolgreichen Buchung.

Der Platzhalter [cfg] muss mit Ihrer traffics Lizenznummer ersetzt werden.

departureAirportList

Definition:
Der Parameter departureAirportList definiert die Liste der Abflufhäfen, welche kommasepariert im Parameter aufgelistet werden. Die Abflügäfen werden dabei mit dem dazugehörigen IATA Code gekennzeichnet.

Typ: String
Format: [A-Z]{3},?

departureAirportList=BER
departureAirportList=TXL,SXF,BER

regionList, locationList, giataIdList, destinationName

Definition
Ein Reiseziel kann über verschiedenen Parameter angesteuert werden. Es ist möglich folgende Ziele zu definieren:

• regionList - Eine Region
• locationList - Einen Ort
• giataIdList - Ein Hotel

Eine Region als Reiseziel

Um eine Region als Reiseziel zu definieren, muss der Parameter regionList mit der passenden ID der Region gefüllt werden.
Weiterhin muss der Parameter destinationName mit dem Regionsnamen gefüllt werden.
Beispiel Mallorca/Balearen: regionList=133&destinationName=Mallorca

regionList=133&destinationName=Mallorca

Einen Ort als Reiseziel

Um einen Ort als Reiseziel zu definieren, müssen die Parameter regionList und locationList mit der passenden ID der Region bzw. der passenden ID des Ortes gefüllt werden.
Weiterhin muss der Parameter destinationName mit dem Ortsnamen gefüllt werden.
Beispiel Palma de Mallorca: regionList=133&locationList=780&destinationName=Palma%20de%20Mallorca

regionList=133&locationList=780&destinationName=Palma%20de%20Mallorca

Ein Hotel als Reiseziel

Um ein Hotel als Reiseziel zu definieren, müssen die Parameter locationList und giataIdList mit der passenden ID des Ortes bzw. der GIATA ID des Hotels gefüllt werden.
Weiterhin muss der Parameter destinationName mit dem Ortsnamen gefüllt werden.
Beispiel Hotel TRYP Barcelona Apolo Hotel: locationList=587&giataIdList=2300&destinationName=Barcelona

locationList=587&giataIdList=2300&destinationName=Barcelona

Es ist möglich Region und Orte zu kombinieren bzw. mehrere Region bzw. Orte in einem Aufruf zu definieren. Dabei ist zu beachten, dass die RegionsIds bzw. OrtsIds kommasepariert angegeben werden bzw. auch im Parameter destinationName die Regionen bzw. Orte kommasepariert aufgelistet werden müssen. Die Reihenfolge der Namen im Parameter destinationName muss der Reihenfolge aus dem Parameter regionList bzw. locationList entsprechen.
Beispiel für Orte Berlin und Barcelona: locationList=2791,587&destinationName=Berlin%7CBarcelona Beispiel für Region Gran Canaria und Mallorca: regionList=128,133&destinationName=Gran%20Canaria%7CMallorca

locationList=2791,587&destinationName=Berlin%7CBarcelona
regionList=128,133&destinationName=Gran%20Canaria%7CMallorca

Für die Regions-, Orts- oder HotelIDs gehen Sie bitte in die IBE und nutzen das Suchfeld für das Reiseziel. Dort können Sie dank unseres Autocompletes nach der Region, dem Ort oder dem Hotel suchen und anschließend nach einer Auswahl sich die benötigten IDs aus der URL nehmen. Eine Auflistung aller Regionen, Orte und Hotels würde nicht praktikabel sein aufgrund der Anzahl.

searchDate

Definition:
Der Parameter searchDate definiert ein Datumsbereich bestehend aus frühesten Anreise, spätesten Rückreise und Reisedauer. Für früheste Anreise und späteste Rückreise steht jeweils ein Datum (DDMMYY) und für die Reisedauer wird ein numerischer Wert (0-99) bzw. Bereich (z.B. 5-9 steht für 5 bis 9 Tage) angegeben.
Der Wert 0 für Reisedauer bedeutet für die IBE eine beliebige Reisedauer.
Der Wert exact für Reisedauer bedeutet für die IBE, dass exact der Zeitraum zwischen Anreise und Rückreise genommen werden soll.

Es ist auch möglich hier ein relatives Datum in Tagen ab heute einzugeben z.B. 10,24,7 früheste Hinreise heute in 10 Tagen und späteste Rückreise heute in 24 Tagen

Typ: String
Format: ([0-9]{6},[0-9]{6},(([0-9]+(-[1-9])?)|(exact)))|([0-9]{1,3},[0-9]{1,3},(([0-9]+(-[1-9])?)|(exact)))

searchDate=120719,310919,7
searchDate=120719,310919,5-9
searchDate=120719,310919,exact
searchDate=10,24,7

adults

Definition
Der Parameter adults definiert die Anzahl der Reiseteilnehmer, welche ein Alter von mindestens 18 Jahren besitzen. Die Anzahl der Reiseteilnehmer mit einem Mindestalter von 18 Jahren kann von 1 bis 4 definiert werden.

Typ: Number
Format: [1-4]

adults=2

children

Definition:
Der Parameter children definiert die Anzahl und das Alter der Reiseteilnehmer mit maximmal 17 Jahren. In dem Parameter children wird das Alter jedes Kindes zum Zeitpunkt der Rückreise kommasepariert angegeben.

Typ: String
Format: [1-9]{1,2},?

children=2
children=1,5,7
children=3,15,17

minBoardType

Definition:
Der Parameter minBoardType definiert die Verpflegungsart, welche mindestens in den Angeboten gegeben sein muss. Sprich welches im Angebot enthalten sein muss.
Die Liste der Verpfelgungsarten, welche mindestens gegegben sein müssen:

Typ: String
Format: (OV|UF|HP|VP|AI)

minBoardType=
minBoardType=OV
minBoardType=UF
minBoardType=HP
minBoardType=VP
minBoardType=AI

minCategory

Definition:
Der Parameter minCategory definiert die Hotelkategorie, welche mindestens in den Angeboten gegeben sein muss. Verdeutlicht wird diese Angabe durch die Anzahl der Sterne, die ein Hotel besitzt. Diese Angabe kann von Veranstalter zu Veranstalter verschieden sein.

Typ: Number
Format: [0-5]{1}

minCategory=0
minCategory=1
minCategory=2
minCategory=3
minCategory=4
minCategory=5

roomTypeList

Definition:
Der Parameter roomTypeList definiert den Zimmertyp, welche mindestens in den Angeboten gegeben sein muss. Es kann ein oder mehrere Zimmertypen angegeben werden. Die Zimmertypen werden kommasepariert dem Parameter roomTypeList übergeben.

Typ: String
Format: (AK|BK|IK|EZ|DZ|...|ZA),?

roomTypeList=EZ
roomTypeList=EZ,DZ
roomTypeList=EZ,DZ,MA,ZA

locatedList

Definition:
Der Parameter locatedList definiert ob ein Angebot einen Meerblick besitzt. Nach Auswahl bzw. Abgabe des Parameters mit dem dazugehörigen Wert werden nur noch Angebote ausgespielt, welche einen Meerblick bieten.

Typ: String
Format: MB

locatedList=MB

maxPricePerPerson

Definition:
Der Parameter maxPricePerPerson definiert den maximalen Preis pro Person, welcher ein Angebot haben kann. Die IBE stellt eine Range per Slider von 150€ bis 1950€ bereit. Es köne aber Werte >1950 angegeben werden. Diese werden dann auch im Filter angezeigt bzw. die Angebote danach gefiltert.

Typ: Number
Format: [0-9]{1,5}

maxPricePerPerson=
maxPricePerPerson=150
maxPricePerPerson=1950
maxPricePerPerson=11950

rating[recommendation]

Definition:
Der Parameter rating[recommendation] definiert die Weiterempfehlungsrate, welche mindestens in den Angeboten gegeben sein muss. Die Weiterempfehlungsrate bezieht sich auf den Anbieter, den Sie ausgewählt haben. Die Firma traffics unetrstützt zur Zeit folgende Dienste für Weiterempfehlungen (holidaycheck, tripadvisor und trustyou). Um einen dieser Dienstleister in der IBE nutzen zu können, müssen Sie über einen eigens verhandleten Kooperationsvertrag bei dem jeweiligen Dienstleister verfügen.

Typ: Number
Format: (70|80|90|100)

rating[recommendation]=
rating[recommendation]=70
rating[recommendation]=80
rating[recommendation]=90
rating[recommendation]=100

flight[directness], returnFlight[directness]

Definition:
Die Parameter flight[directness] und returnFlight[directness] definieren den Direktflugkenner bei den gesuchten Angeboten. Wenn beide Paremter mit dem Wert 'N' versehen werden, werden nur Angebote mit Direktflügen gesucht.

Typ: Character
Format: 'N'

flight[directness]=N&returnFlight[directness]=N

inclusiveList

Definition:
Der Parameter inclusiveList definiert die Transferoptionen, welche mindestens in den Angeboten gegeben sein müssen. Als Transferoptionen kommen folgende Optionen in Frage, welche dem Parameter mitgegeben werden können. Es können auch Kombinationen von Optionen kommasepariert übergeben werden.

Typ: String
Format: (MT|OT|ZG|MW)+

inclusiveList=MT
inclusiveList=MT,ZG
inclusiveList=MW

flight[stopover], returnFlight[stopover]

Definition:
Die Parameter flight[stopover] und returnFlight[stopover] definieren maximale Anzahl an Stopps bei den gesuchten Angeboten.

Typ: Number
Format: [0-9]{1}

flight[stopover]=1
returnFlight[stopover]=1

Flugzeiten (searchDate Erweiterung für Flugstrecke)

Definition:
Der Parameter searchDate kann optional um gewünschte Zeitspanne für Hin- und Rückflug erweitert werden.

Typ: String
Format: [searchDate],,,,,((0[0-9]|1[0-9]|2[0-3]|[0-9]):[0-5][0-9],(0[0-9]|1[0-9]|2[0-3]|[0-9]):[0-5][0-9],(0[0-9]|1[0-9]|2[0-3]|[0-9]):[0-5][0-9],(0[0-9]|1[0-9]|2[0-3]|[0-9]):[0-5][0-9])

searchDate=120719,310919,7,,,,,,05:00,13:00,07:00,17:00

flight[carrierCodeList], returnFlight[carrierCodeList]

flight[carrierCodeList]=DE,FR,U2,XQ,XG
returnFlight[carrierCodeList]=DE,FR,U2,XQ,XG

tourOperatorList

Definition:
Der Parameter tourOperatorList definiert die Veranstalter, welche in den Angeboten gegeben sein müssen. Es kann ein oder mehrere Veranstalter dem Parameter übergeben werden. Dabei werden die Veranstalterkürzel kommasepariert als Zeichenkette dem Parameter übergeben.

Typ: String
Format: (1AV|4YBK|5VF|A2B|...|XPUR)+,?

tourOperatorList=FTI
tourOperatorList=5VF,ALL
tourOperatorList=5VF,ALL,TUID

keywordList

Definition:
Der Parameter keywordList definiert die Themenreisen bzw. die Merkmale eines Hotels, nach welchen die Angeboten gefiltert werden müssen. Es können meherer Themen bzw. Merkmale der Liste hinzugefügt werden, wobei diese dann kommasepariert aufgelistet werden müssen. Die Reihenfolge spielt keine Rolle bei Themen oder Merkmalen.

Werte für Themenreisen

Werte für Merkmale des Hotels

Typ: String
Format: (bus|bhn|cmp|...|stn|sws|...|fin|rin)*,?

keywordList=chf
keywordList=chf,fpg,rcb

hotelChainList

Definition:

Es kann eine oder mehrere (kommasepariert) Hotelketten (GIATA) Codes angegeben werden.

Typ: String
Format: ([0-9]{4}),?

hotelChainList=
hotelChainList=1000
hotelChainList=1000,1006

Sortierung

Parameter sortBy

Sortiert die angzeigten Angebote:

Beispiel:

sortBy=price

Je nach Reisart und Schritt stehen folgende Möglichkeiten bereit:

Parameter sortDir

Aufsteigend (up) oder absteigend (down) sortieren:

Beispiele:

sortDir=up
sortDir=down

ref Parameter

Mit dem ref Parameter kann im Deeplink optional ein Kenner mit übergeben werden. Dieser wird dann im Buchungsrequest übergeben. So ist erkennbar wo die Buchung herkam.

ref=Kunde123

Feeds

If you want to create dynamic teasers on your own website, like the top 10 hotels, you can use our "feeds" API.

Example for package:

https://ibe.traffics.de/api/v3/rest/feeds/hotels/top/?licence=[cfg]&productType=pauschal&searchDate=21,90,7&adults=2

Example for hotel only:

https://ibe.traffics.de/api/v3/rest/feeds/hotels/top/?licence=[cfg]&productType=hotelonly&searchDate=21,90,7&adults=2

you have to replace [cfg] with your 16 digets traffics licence

For more details check out our Swagger documentation.