Mit der API-Testjourney können Sie eine externe Anbindung an Bookyt vorbereiten und testen. Die Testumgebung unterstützt Sie dabei, Stammdaten abzurufen, Verfügbarkeiten zu prüfen, Buchungen anzulegen und Stornierungen zu testen.
API-Testjourney öffnen
Öffnen Sie im Bookyt-Backend die Einstellungen und wechseln Sie zu „Grundeinstellungen“ → „API“. Wenn die API-Schnittstelle für Ihren Account gebucht ist, wird dies im grün hinterlegten Hinweis angezeigt.
Starten Sie die Testumgebung anschließend über „API Einbuchung Testjourney“.
Stationen und Kategorien abrufen
In diesem Bereich sehen Sie den XML-Token, der die Grundlage für die Kommunikation zwischen Bookyt und Ihrer externen Lösung bildet. Über „Laden“ ruft Bookyt Stations-, Kategorie- und Artikeldaten ab und generiert die passenden API-Calls.
Der Abruf von Stations- und Kategoriedaten erfolgt per GET.
Tarife und Verfügbarkeit prüfen
Importieren Sie Tarife und Verfügbarkeiten über „Laden“. Sie können Mietbeginn, Mietende, Stations-ID und Kategorie-ID manuell anpassen und danach erneut einen Call generieren.
Wenn Sie die Bookyt-Tariffunktion nicht nutzen möchten, können Sie bei der Einbuchung preisliste_id = 0 setzen und Preise direkt in den Positionen übergeben.
Der Abruf von Tarif- und Verfügbarkeitsdaten erfolgt ebenfalls per GET.
Buchung erstellen
In diesem Schritt wird der Payload generiert, der an Bookyt übertragen wird, um eine Buchung anzulegen. Über „Senden“ überträgt die Testumgebung den Payload und erstellt die Buchung im System.
Der generierte QR-Code wird systemweit genutzt. Er dient als Online-Quittungsseite für den Kunden und kann außerdem mit der Bookyt-App erfasst werden, um die Buchung für Abholung und Rückgabe aufzurufen.
Das konkrete Fahrzeug wird beim Einbuchen im Hintergrund durch Bookyt zugewiesen. Das Senden der Buchungsdaten erfolgt per POST.
Storno testen
Tragen Sie eine Vorgangsnummer ein und klicken Sie auf „Stornieren“, um den angegebenen Vorgang zu stornieren. Bookyt erzeugt dabei die hinterlegten Stornobelege. Zusätzlich wird ein Beispiel-Call generiert, mit dem eine zuvor angelegte Buchung storniert werden kann.
Das Senden der Stornodaten erfolgt per POST.
