Zum Inhalt springen
Aufgabe, Kanäle und Partner-API

Partner API: Schlüssel und Webhooks verwalten

Mit der Partner API verbindest du eigene Buchungsseiten, Apps und Integrationen mit STRYK. Du erstellst Schlüssel mit genau den nötigen Rechten und richtest Webhooks ein.

Zuletzt aktualisiert: Inhaber, Entwickler
Inhalt
  1. Bevor du beginnst
  2. API öffnen
  3. API-Schlüssel erstellen
  4. Schlüssel verwalten
  5. Webhooks einrichten
  6. Webhooks verwalten
  7. So prüfst du das Ergebnis
  8. Wenn etwas nicht klappt
  9. Das hängt damit zusammen

Bevor du beginnst

  • Du brauchst das Recht Channels verwalten. Nur damit siehst du die Zeile API auf der Seite Kanäle.
  • Kläre, welche Bereiche die Integration lesen oder schreiben muss. Ein Schlüssel bekommt nur diese Rechte.
  • Eine Integration ruft die Partner API aus ihrem Server auf. Den Schlüssel legst du nie in Browser-Code oder in eine App. Endpunkte, Parameter und Beispiele findest du in der Entwicklerdokumentation. Dort erklärt der Abschnitt Authentifizierung und Scopes, was jedes Recht erlaubt.
  • Webhooks brauchen einen Empfänger mit einer Adresse, die mit https:// beginnt.

API öffnen

In STRYKKanäle

  1. Wähle unter Eigene Anbindungen die Zeile API mit dem Zusatz „API-Schlüssel und Webhooks“. Der Dialog API öffnet sich.
  2. Wähle den Tab API-Schlüssel oder Webhooks. Mit Entwicklerdokumentation in der Kopfzeile des Dialogs öffnest du das Entwicklerportal.
  1. Tabs API-Schlüssel und Webhooks
  2. Schlüssel mit Rechten
  3. Aktionen des Schlüssels

API-Schlüssel erstellen

In STRYKKanäleAPIAPI-Schlüssel

  1. Wähle API-Schlüssel erstellen. Der Dialog API-Schlüssel erstellen öffnet sich.
  2. Trage den Name ein, zum Beispiel „Buchungsseite“.
  3. Wähle unter Rechte ein Muster: Nur lesen (alle Bereiche lesen), Lesen & schreiben (schreiben, wo es möglich ist) oder Benutzerdefiniert. Bei Benutzerdefiniert wählst du je Bereich Kein Zugriff, Lesen oder Schreiben. Die Bereiche sind Hotel & Zimmer, Verfügbarkeit, Preise & Tarife, Buchungen, Gäste, Zahlungen und Rechnungen. Schreiben schließt Lesen ein. Rechnungen sind Fiskalbelege des Hotels und lassen sich per API nur lesen.
  4. Optional: Öffne Erweitert. Wähle den Ablauf: Kein Ablauf, 30 Tage, 90 Tage, 1 Jahr oder Datum (ab morgen, höchstens in drei Jahren). Trage unter IP-Einschränkung je Zeile eine Adresse oder ein CIDR-Netz ein, höchstens 20. Leer erlaubt alle Adressen. Unter Notiz hältst du einen internen Hinweis fest.
  5. Wähle Erstellen. STRYK zeigt API-Schlüssel erstellt mit dem Schlüssel und dem Hinweis Nur jetzt sichtbar.
  6. Kopiere den Schlüssel und speichere ihn zum Beispiel im Passwortmanager. Wähle Fertig.

Schlüssel verwalten

In STRYKKanäleAPIAPI-Schlüssel

Die Liste zeigt je Schlüssel Name, den Anfang des Schlüssels, die Rechte, Erstellt, Zuletzt verwendet, Ablauf und den Status: Aktiv, Läuft bald ab, Widerrufen oder Abgelaufen. Wähle einen Schlüssel, um Rechte, Ablauf, Erlaubte IP-Adressen, Rate-Limit (Anfragen pro Minute), Nutzung, Letzte Anfragen und den Verlauf zu sehen.

  1. Öffne in der Zeile das Menü Optionen.
  2. Wähle Neu erzeugen, wenn die Integration einen neuen Schlüssel mit denselben Rechten bekommen soll. Wähle unter Bisheriger Schlüssel Alter Schlüssel noch 24 h gültig, damit du die Integration umstellen kannst, oder Sofort widerrufen. Bestätige mit Neu erzeugen. STRYK zeigt den neuen Schlüssel einmal an.
  3. Wähle Widerrufen und bestätige API-Schlüssel widerrufen?, um einen Schlüssel sofort zu sperren. Anfragen mit diesem Schlüssel lehnt STRYK dann ab.

Webhooks einrichten

In STRYKKanäleAPIWebhooks

Ein Webhook sendet die gewählten Ereignisse signiert per HTTPS an deine Systeme.

  1. Wähle Webhook anlegen. Der Dialog Neuer Webhook öffnet sich.
  2. Trage die Empfänger-URL ein, zum Beispiel https://crm.nordlicht.invalid/hooks/stryk. Die Adresse muss mit https:// beginnen.
  3. Optional: Trage eine Beschreibung ein, zum Beispiel „Buchungen an unser CRM“.
  4. Wähle unter Ereignisse mindestens eins: Buchung angelegt, Buchung geändert, Buchung storniert, Gast geändert, Verfügbarkeit geändert, Preis geändert, Zahlung geändert oder Zimmerstatus geändert. Mit Alle auswählen und Auswahl aufheben wählst du alle oder keine.
  5. Wähle Webhook anlegen. STRYK zeigt Dein Signiergeheimnis einmal an.
  6. Hinterlege das Geheimnis in deinem Empfänger. Wie der Empfänger die Signatur prüft, beschreibt die Entwicklerdokumentation unter Webhooks und Signaturprüfung.
  7. Wähle den Webhook und dann Testereignis senden. STRYK meldet „Testereignis wird zugestellt.“

Webhooks verwalten

Ort: Kanäle > API > Webhooks, Webhook wählen

  • Mit dem Schalter Zustellung aktiv pausierst oder aktivierst du den Webhook. Pausierte Webhooks erhalten keine Ereignisse. Nach dem Aktivieren beginnt die Zustellung mit neuen Ereignissen.
  • Letzte 7 Tage, Letzter Erfolg und Letzter Fehler zeigen den Stand. Unter Zustellungen siehst du jede Zustellung mit HTTP-Status und Versuche. Mit Erneut senden wiederholst du eine Zustellung.
  • Geheimnis erneuern erzeugt ein neues Geheimnis. Das bisherige bleibt noch 24 Stunden gültig, damit du den Empfänger umstellen kannst.
  • Mit Bearbeiten änderst du Adresse und Ereignisse, mit Löschen und der Bestätigung Webhook löschen? entfernst du ihn. Das Zustellprotokoll bleibt 30 Tage erhalten.

So prüfst du das Ergebnis

  • Beim Schlüssel steht Zuletzt verwendet mit Datum, sobald die Integration ihn nutzt. Anfragen 24 h zählt die Anfragen.
  • Beim Webhook zeigt Letzte 7 Tage „{Zahl} zugestellt, {Zahl} fehlgeschlagen“, und das Testereignis steht unter Zustellungen.

Wenn etwas nicht klappt

Was du siehstUrsacheSo löst du es
„Wähle mindestens ein Recht.“Kein Bereich hat ein Recht.Wähle ein Muster oder gib mindestens einem Bereich Lesen oder Schreiben.
„Bitte gib einen Namen ein.“Der Name fehlt.Trage einen Namen ein.
„Bitte prüfen:“ mit einer AdresseEine Adresse in der IP-Einschränkung ist ungültig.Korrigiere die Adresse oder das CIDR-Netz. Erlaubt sind höchstens 20 Einträge.
„Bitte wähle ein Datum ab morgen, höchstens in drei Jahren.“Das Ablaufdatum liegt außerhalb des Zeitraums.Wähle ein Datum ab morgen, das höchstens drei Jahre entfernt liegt.
„Die Adresse muss mit https:// beginnen.“Die Empfänger-URL ist keine HTTPS-Adresse.Trage eine Adresse mit https:// ein.
„Wähle mindestens ein Ereignis.“Der Webhook hat kein Ereignis.Wähle unter Ereignisse mindestens eins.
Wegen wiederholter Fehler pausiertDer Empfänger antwortet nicht mit einem 2xx-Status.Prüfe, ob der Empfänger erreichbar ist, und wähle Wieder aktivieren.
„Aktiviere den Webhook, um ein Testereignis zu senden.“Der Webhook ist pausiert.Aktiviere Zustellung aktiv und sende das Testereignis.
„Die Auswahl konnte nicht geladen werden. Bitte schließen und erneut öffnen.“Die Liste der Rechte und Ereignisse ist nicht geladen.Schließe den Dialog und öffne ihn erneut.
Fragen zu STRYK?