Wofür dient die API

Die API ist eine Alternative zu den Widgets, um Ihre Online-Verkaufspräsenz aufzubauen. Während Widgets vorgefertigte, sofort einsetzbare Module sind, ermöglicht Ihnen die API, Ihre eigene Website zu erstellen, indem Sie die Tourbiz-Daten direkt abrufen: Katalog, Verfügbarkeiten, Reservierungen.

Der Hauptvorteil besteht darin, eine Website zu erhalten, deren Design und Nutzerführung Sie vollständig selbst bestimmen, ohne von der Optik der Widgets abhängig zu sein. Dies ist das geeignete Werkzeug für Reiseveranstalter und Marktplätze, die ihre Datenflüsse mit einem oder mehreren Partnern automatisieren möchten.

Der API-Schlüssel

Die Verwaltung der API basiert auf einem Authentifizierungsschlüssel. Über das Menü Online-Verkauf › API wird ein Schlüssel generiert und oben auf der Seite angezeigt (im Format tourbiztest_…).

Dieser Schlüssel wird auf zwei Arten verwendet:

  • In der Swagger-Dokumentation, über die Schaltfläche Authorize
  • In den HTTP-Headern Ihrer Anfragen

Die Dokumentation und die Endpoints

Die vollständige Dokumentation ist unter folgender Adresse verfügbar:

<https://www.tourbiz.net/api/v2/doc#/>

Sie wird im Swagger-Format präsentiert und fasst die Endpoints in drei Kategorien zusammen:

Kategorie Inhalt
Supplier Informationen zum Anbieter
Products Produktliste, Produktkarte, Verfügbarkeit, Kalender
Bookings Erstellung, Bestätigung, Stornierung, Abfrage und Aktualisierung von Reservierungen

Die URL eines Aufrufs erstellen

Die Basis-URL der Aufrufe erhält man, indem man /doc#/ aus der Adresse der Dokumentation entfernt:

<https://www.tourbiz.net/api/v2/>

Anschließend fügt man den Pfad jedes Endpoints hinzu, zum Beispiel /products oder /availability.

Die per API zugänglichen Produkte ankreuzen

Auf der API-Seite listet ein Bereich die verfügbaren Produkte auf und ermöglicht es, weitere hinzuzufügen, nach Anbieter sortiert, über ein einfaches Kontrollkästchen.

⚠️ Wichtiger Hinweis: Auch die Buchungs-Widgets stützen sich auf die API. Sie müssen Ihre Produkte daher im Reiter API von Online-Verkauf ankreuzen, bevor Sie sie in den Widgets auswählen können. Dieser Schritt ist Voraussetzung für beide Verteilungsarten.

Diese Auswahl ermöglicht es auch, zu vermeiden, dass nicht für den Online-Verkauf bestimmte Back-Office-Produkte wie Privatisierungen über die API zugänglich gemacht werden.

Die verfügbaren Inhalte: API-Texte und API-Bilder

Die API stellt außerdem erweiterte Inhalte bereit, um Ihre individuelle Website zu speisen. Diese Inhalte werden in der Produktkarte im Bearbeitungsmodus über zwei eigene Reiter eingegeben.

API-Texte

Im Reiter Texte fasst ein Bereich API-Texte (getrennt von den Standard-Produkttexten) Folgendes zusammen:

  • Feed-Titel
  • Kurzbeschreibung des Feeds
  • Enthaltener / nicht enthaltener Inhalt

Diese Felder können pro Übersetzungssprache verwaltet werden.

API-Bilder

Im Reiter Bilder ist ein Bereich API-Bilder getrennt vom Standard-Produktbild.

Diese Inhalte sind somit unabhängig von den anderswo im Back-Office verwendeten.