Buuky Help
Diese Seite ist auch verfügbar in: English

Buuky-API

Schlagworte:

Einführung

REST API

Buuky bietet eine REST API, die den Abruf von Buchungsdaten ermöglicht. Im Sinne des Datenschutzes werden die Buchungsdaten anonymisiert, sprich ohne personenbezogene Daten zurück geliefert. Integrationen kommen oft mit individuellen Fragen und Anforderungen. Hierbei hilft unser Team gerne weiter und ist unter team@buuky.app erreichbar.

Einrichtung

Die Buuky REST API ist bei jedem Buuky Account inklusive. Der Zugang zur Buuky API wird über API-Schlüssel geschützt. Als Empfehlung sollte auch für jede Integration oder für jeden Aufrufer der API ein separater Schlüssel angelegt werden, um hierüber den Zugriff auch dediziert verwalten zu können. Für die Einrichtung werden Administrationsrechte benötigt. In der Buuky Konfiguration, die über das Personen-Icon rechts oben zu erreichen ist, befindet sich in der linken Navigation unter dem Punkt „Buuky API“ die Verwaltung der API-Schlüssel. Die Schlüssel-Übersicht zeigt die bereits konfigurierten API-Schlüssel inklusive Erstellungsdatum, der letzten Nutzung und der Möglichkeit den Schlüssel- Namen zu bearbeiten oder ihn zu löschen.

Einrichtung

Anlegen eines neuen API-Schlüssels

Über den Button „Neuer Schlüssel“ kann ein weiterer Schlüssel hinzugefügt werden. Nach der Eingabe eines Namens wird in einem zweiten Dialog der eigentliche API Key angezeigt. Dieser sollte abgespeichert werden, da er nur einmalig angezeigt werden kann und anschließen verschlüsselt abgespeichert wird.

Neuer Schlüssel

Schlüssel

API-Aufruf

Basis URL

Die Buuky API ist unter einer zentralen Basis-URL erreichbar: https://my.buuky.app/api/v1/

Authentifizierung

Jeder API-Aufruf erfordert eine Authentifizierung mittels des zuvor eingerichteten API-Schlüssels und der eindeutigen Tenant-ID. Sollte letztere nicht bekannt sein kann diese einfach auf der Buuky API Seite nachgeschaut werden. Der API-Schlüssel und die Tenant-ID werden bei jedem API-Aufruf über die Header x-auth-key und x-auth-tenant mitgeliefert, wie im folgenden Beispiel CURL-Aufruf:

curl -X 'GET' \
    'https://my.buuky.app/api/v1/facilities' \
    -H 'accept: application/json' \
    -H 'x-auth-key: 00000-0000-0000-0000-000000' \
    -H 'x-auth-tenant: mytenantid'

API-Endpunkte

Die genaue Beschreibung der API-Endpunkte ist als OpenAPI-Spezifikation beim Buuky Team entweder direkt per E-Mail an team@buuky.app oder über das Support Portal erhältlich. Die Endpunkte bieten die Möglichkeit Standort-Informationen sowie die Buchungen je Standort abzurufen. Sollten weitere Daten benötigt werden steht das Buuky Team über die zuvor genannten Wege ebenfalls zur Verfügung.


Diese Seite ist auch verfügbar in: English