Der Buchungs-API-Endpunkt ist ein spezieller Endpunkt, der die Erstellung von Integrationen von Buchungsplattformen erleichtert. Dieselben Integrationen könnten auch durch die Verwendung der API-Endpunkte für Benutzer, Berechtigungen, Schloss-Aktivierungslinks und Einladungen erstellt werden. Der Buchungs-API-Endpunkt wird auch von der KleverKey-Zapier-App verwendet und das ist der empfohlene Weg, ihn zu nutzen, aber es ist auch möglich, ihn direkt zu verwenden.
Gastzutritte werden in der KleverKey API Lock Acivation Links (Schloss-Aktivierungslinks) genannt.
Der Buchungs-API-Endpunkt unterstützt die folgenden Integrationsszenarien:
- Erteilen/Entziehen von Berechtigungen an/von einem Benutzer (die Eigenschaft useLockActivationLinks muss false sein)
- Wenn der Benutzer bereits ein KleverKey-Konto hat und der Organisation bereits beigetreten ist, wird eine Berechtigung direkt erteilt
- Wenn der Benutzer bereits ein KleverKey-Konto hat, aber der Organisation noch nicht beigetreten ist, wird eine Einladung zum Beitritt zur Organisation und zum Erhalt von Berechtigungen gesendet
- Wenn der Benutzer kein KleverKey-Konto hat, wird eine Einladung zum Erstellen eines KleverKey-Kontos, zum Beitritt zur Organisation und zum Erhalt von Berechtigungen gesendet
- Gastzugang zu/von einem Benutzer gewähren/entziehen (Eigenschaft useLockActivationLinks muss true sein)
- Der Benutzer erhält ein E-Mail oder SMS mit einem Link für den Zugang zu einem oder mehreren Schlössern
Die Eigenschaft "operationType" wird verwendet, um zu definieren, ob der Zugang gewährt oder entzogen werden soll:
- CreateOrUpdate = Erteilen
- Delete = Entziehen
Die Eigenschaft "permission" wird verwendet, um den Berechtigungstyp und die Details zu definieren:
- BookingPermissionAlways = PermissionType Always, TimeProfile = None
- BookingPermissionTimeSlot = PermissionType TimeProfile, TimeProfile mit RepetitionType.None
- BookingPermissionWeeklyItems = PermissionType TimeProfile, TimeProfile mit RepetitionType.Weekly
Es gibt mehrere Eigenschaften mit Referenz-IDs, die verwendet werden, um den richtigen Benutzer und die richtige Berechtigung in nachfolgenden Anfragen an den Buchungs-API-Endpunkt zu finden:
Die Eigenschaft "userReferenceId" muss eine eindeutige Benutzer-ID sein, die von der Buchungsplattform bereitgestellt wird. Wenn die Buchungsplattform keine eindeutige Benutzer-ID bereitstellt, kann die E-Mail-Adresse verwendet werden. Aber sind Sie sich bewusst, dass, wenn die E-Mail-Adresse als Referenz-ID verwendet wird und sie sich in der Buchungsplattform ändert, der Benutzer nach einer neuen Buchungsanfrage ein neues KleverKey-Konto erhält. Wenn die "userReferenceId" eine eindeutige Benutzer-ID ist, kann die E-Mail-Adresse in der Buchungsplattform geändert werden und der Benutzer kann danach immer noch das selbe KleverKey-Konto verwenden.
Die Eigenschaft "referenceId" im Objekt "permission" muss eine eindeutige ID der Buchung sein, die von der Buchungsplattform bereitgestellt wird. Diese Referenz-ID wird verwendet, um Berechtigungen oder Schloss-Aktivierungslinks zu aktualisieren, wenn sich die Buchung geändert hat (z.B. ein anderes Zimmer in einem Hotel) oder um Berechtigungen oder Schloss-Aktivierungslinks zu entziehen, wenn eine Buchung storniert wird.
Der Buchungs-API-Endpunkt unterstützt keine Zugriffsgruppen.
Bitte gehen Sie zur KleverKey API-Dokumentation und öffnen Sie "/organizations/{organizationId}/bookings", um weitere Informationen über den Endpunkt zu erhalten.
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.