Apps und Integrationen – Selbstbedienungs-API

Dieser Schnellstartleitfaden bietet grundlegende Informationen zur API-Schlüssel-Authentifizierung, die für den Zugriff auf Cloudbeds-API-Ressourcen erforderlich ist. Dieser Leitfaden hilft Ihnen, schnell einen API-Schlüssel zu erhalten, um mit Ihrer Authentifizierung zu beginnen.

Wenn Sie ein Technologiepartner sind, können Sie einen API-Schlüssel auf Unterkunftsebene erstellen, um schnell mit Ihrer Entwicklung zu starten. Sie müssen jedoch vor dem Zertifizierungsprozess die Unterstützung von API-Schlüsseln auf Partner-Ebene gemäß unserem API-Schlüssel-Authentifizierungsleitfaden für Technologiepartner implementieren.

Für die OAuth-2.0-Authentifizierungsmethode siehe Alternative OAuth-2.0-Authentifizierungsmethode.

Bevor Sie API-Zugangsdaten erstellen

Bevor Sie API-Zugangsdaten erstellen, öffnen Sie die Seite API-Zugangsdaten in Cloudbeds. Was Sie auf dieser Seite sehen, hängt davon ab, ob der API-Zugriff bereits in Ihrem Cloudbeds-Paket enthalten ist.

Das folgende Beispiel zeigt die Seite API-Zugangsdaten, wenn der API-Zugriff noch angefordert werden muss.

Sobald der API-Zugriff für Ihr Konto aktiviert ist, kehren Sie zur Seite API-Zugangsdaten zurück und fahren Sie mit den untenstehenden Schritten fort.

1. API-Zugangsdaten erstellen

Sehen Sie sich dieses Video an, um den Prozess der Erstellung von API-Schlüsseln zu verstehen

Sobald der API-Zugriff aktiviert ist, erstellen Sie zuerst die Integration. Generieren Sie dann den API-Schlüssel, wählen Sie die erforderlichen Berechtigungen und Unterkünfte aus und autorisieren Sie die Verbindung.

1. Melden Sie sich bei Ihrem Cloudbeds-Konto unter https://signin.cloudbeds.com/ an und navigieren Sie zu:

   Account -> Apps & Marketplace

2. Öffnen Sie die Registerkarte API-Zugangsdaten.

3. Klicken Sie auf + Neue Zugangsdaten.

   Die Seite für API-Zugangsdaten zeigt Ihre bestehenden Integrationen und die Schaltfläche + Neue Zugangsdaten, mit der Sie eine neue Integration starten können.

   

   Sie können auch zuvor erstellte Client-Zugangsdaten bearbeiten, wenn Sie diesen Eintrag konvertieren möchten. In diesem Fall springen Sie zu Schritt 6.

4. Füllen Sie die Details für die neue API-Integration aus:

   1. Geben Sie den Namen Ihrer Integration oder Anwendung ein.
   2. Wählen Sie den Integrationstyp aus, der am besten zu Ihrer Anwendung passt.
   3. Da die Verwendung eines API-Schlüssels keine funktionierende Weiterleitungs-URL erfordert, können Sie https://localhost im Feld Weiterleitungs-URL eingeben.
   4. Aktivieren Sie Für gesamte Organisation aktivieren, wenn die Integration für mehrere Unterkünfte in der Organisation verfügbar sein soll.
   5. Klicken Sie unten rechts auf Speichern.

   Das Formular für die neue API-Integration enthält den Integrationsnamen, den Typ, die Weiterleitungs-URL und die organisationsweite Einstellung.

   

5. Cloudbeds erstellt Client-Zugangsdaten mit einer Client-ID und einem Client-Secret. Diese Attribute sind im Payload einer API-Schlüssel-Anfrage nicht erforderlich, sodass Sie den Dialog schließen und mit der Erstellung des API-Schlüssels fortfahren können.

   Der Bestätigungsdialog erinnert Sie außerdem daran, dass das Client-Secret nach dem Schließen des Dialogs nicht erneut angezeigt werden kann.

   

6. Suchen Sie die Integration in der API-Zugangsdaten-Tabelle. Klicken Sie in der Spalte API-Schlüssel auf Erstellen.

   Die neu erstellte Integration erscheint als Zeile in der API-Zugangsdaten-Tabelle, bevor ein API-Schlüssel generiert wurde.

   

7. Sobald Sie in der gewünschten Zeile auf den Erstellen-Button klicken, wird Ihnen eine Liste von Berechtigungsbereichen angezeigt, die Sie auswählen können.

   Die Auswahl der Berechtigungsbereiche sollte mit den API-Endpunkten übereinstimmen, die Sie verwenden möchten. Weitere Informationen finden Sie unter Über die Cloudbeds-API.

8. Wählen Sie die erforderlichen Berechtigungen aus, indem Sie jede Berechtigung anklicken, und klicken Sie dann auf Erstellen.

   Im Dialog „Neuer API-Schlüssel“ sind die verfügbaren Lese-, Schreib- und Löschberechtigungen nach API-Berechtigungsbereich gruppiert.

   

9. Wählen Sie aus, mit welchen Unterkünften die Anwendung verbunden werden soll. Wählen Sie Alle Unterkünfte verbinden, um Schlüssel zu generieren, die für alle Unterkünfte innerhalb der Organisation funktionieren, und klicken Sie auf Weiter.

   

10. Überprüfen Sie die Berechtigungen, die die Anwendung anfordert, und klicken Sie dann auf Zugriff erlauben.

    Die Autorisierungsseite listet die Berechtigungsbereiche auf, die mit der Anwendung geteilt werden, bevor der Zugriff gewährt wird.

    

11. Cloudbeds erstellt den API-Schlüssel nach der Autorisierung.

    Kopieren und speichern Sie den API-Schlüssel sofort. Der vollständige API-Schlüssel wird nur bei der Erstellung angezeigt. Sobald Sie den Dialog schließen, können Sie diesen API-Schlüssel nicht erneut ansehen. Speichern Sie ihn in einem sicheren Zugangsdaten-Manager oder an einem anderen sicheren Ort.

    Im Dialog „API-Schlüssel erstellt“ wird der Schlüssel zusammen mit dem Hinweis angezeigt, dass er nach dem Schließen des Dialogs nicht erneut angezeigt werden kann.

    

2. Verwendung deines API-Schlüssels

Du kannst den API-Schlüssel jetzt verwenden, um auf die Cloudbeds-API zuzugreifen, indem du den API-Schlüssel im Anforderungsheader als x-api-key oder als Bearer-Token einfügst.

Hier sind einige Beispiele:

curl --location '<https://hotels.cloudbeds.com/api/v1.2/getHotels'> \--header 'Authorization: Bearer cbat_EE*** ' \

curl --location '<https://hotels.cloudbeds.com/api/v1.2/getHotels'> \--header 'x-api-key: cbat_EE*** ' \

3. Löschen oder Ersetzen eines API-Schlüssels

Du kannst einen Schlüssel jederzeit entfernen oder neu generieren. Suche in der API-Zugangsdaten-Tabelle die Spalte API-Schlüssel und verwende die verfügbare Aktion für den Schlüssel.

Die API-Zugangsdaten-Tabelle zeigt den gespeicherten API-Schlüssel nach der Erstellung maskiert an.

FAQ

Laufen API-Schlüssel ab?

Sie laufen nicht ab, solange sie mindestens einmal alle 30 Tage verwendet werden.

Wie füge ich nach der Erstellung eines API-Schlüssels zusätzliche Berechtigungsbereiche hinzu?

Rufe die Registerkarte API-Zugangsdaten auf, finde die Spalte API-Schlüssel für die entsprechenden Zugangsdaten und klicke auf den Papierkorb-Button, um den API-Schlüssel zu löschen.

Nach dem Löschen kannst du einen neuen API-Schlüssel mit den korrekten Berechtigungsbereichen erstellen.

Wie füge ich API-Schlüssel in Postman hinzu?

Du kannst deinen API-Schlüssel im Autorisierungs-Tab von Postman als API-Schlüssel oder Bearer-Token einfügen.

Werden API-Schlüssel für Organisations-/Gruppenkonten auf Unterkunftsebene unterstützt?

Organisationsbenutzer, die den API-Zugriff für mehrere Unterkünfte aktivieren möchten, können beim Ausfüllen des Formulars Neue API-Integration in Schritt 4 der Erstellung von API-Zugangsdaten die Option Für gesamte Organisation aktivieren auswählen. Während der Autorisierung können sie dann auswählen, mit welchen Unterkünften die Anwendung verbunden werden soll.

• Weitere Informationen zu Richtlinien, Preisgestaltung und Anwendungsfällen findest du unter API-Zugriff für Unterkünfte und Gruppenkonten.