SH StraivPMS
Startseite · Anleitungen · API-Key erzeugen
Setup · 20 Minuten

Straiv-API-Key erzeugen und im StraivPMS hinterlegen

Diese Anleitung führt Sie durch die vier Schritte, mit denen Sie einen API-Key im Straiv Workspace erzeugen, den Scope minimal einstellen und den Key im StraivPMS-Workspace hinterlegen. Voraussetzung: aktiver Straiv-Vertrag, Administrator-Rechte in Ihrem Straiv-Konto, ein aktives StraivPMS-Modul.

Schritt 1 — Straiv Workspace öffnen

Melden Sie sich mit Ihren Straiv-Zugangsdaten in Ihrem Straiv Workspace an. Wir empfehlen, die Anmeldung in einem Browser vorzunehmen, der die Zwei-Faktor-Anmeldung (2FA) unterstützt. Falls Sie 2FA in Straiv noch nicht aktiviert haben, ist dies ein guter Anlass für die Aktivierung.

Schritt 2 — API-Bereich aufrufen

Klicken Sie in der linken Menüleiste auf „Einstellungen" und dann in der zweiten Ebene auf „Integrationen". Im Reiter „API-Keys" finden Sie die Übersicht aller vergebenen Keys. Falls der Reiter fehlt, prüfen Sie, ob Ihre Rolle „Administrator" ist.

Schritt 3 — Neuen API-Key erzeugen

Klicken Sie auf „+ Neuen Key erzeugen". Vergeben Sie einen sprechenden Namen, z. B. „StraivPMS — Meldeschein". Wählen Sie beim Scope die Punkte, die im StraivPMS-Modul-Beschreibung als „benötigter Scope" gelistet sind. Aktivieren Sie „Ablaufdatum" mit einem Jahr in der Zukunft. Klicken Sie auf „Erzeugen".

Schritt 4 — Key kopieren und im StraivPMS einfügen

Der Klartext-Key wird Ihnen einmal angezeigt. Kopieren Sie ihn unmittelbar. Öffnen Sie im StraivPMS-Workspace das entsprechende Modul und klicken Sie auf „Straiv verbinden". Fügen Sie den Key ein, bestätigen Sie mit „Verbindung testen". Nach positivem Test erscheint das Modul mit Status „Verbunden — Sync aktiv".

Fehlerhinweise

  • „401 Unauthorized" — Key falsch kopiert oder in Straiv bereits widerrufen. Neuen Key erzeugen.
  • „403 Forbidden" — Scope zu eng. In Straiv Scope erweitern und Verbindung erneut testen.
  • „Timeout" — vorübergehendes Netzwerk­problem, in 60 Sekunden erneut testen.