API-Zugriff

SmoovOps kann direkt aus deinen eigenen Skripten, CI-Pipelines oder Tools wie Zapier aufgerufen werden — ohne Browsersitzung — mithilfe eines persönlichen API-Tokens.

Was ein persönliches API-Token ist

Ein persönliches API-Token (PAT) ist eine geheime Zugangsdaten, die mit smv_live_ beginnt und dich und dein Konto gegenüber der SmoovOps-API identifiziert. Es funktioniert genauso wie eine Anmeldesitzung — alles, was du in der App tun kannst, kann auch eine Anfrage mit deinem Token tun — behandle es also wie ein Passwort: teile es nicht und committe es nicht in die Versionsverwaltung.

Zusätzlich zu deinem Token gibt dir SmoovOps auch einen API-Schlüssel. Dies ist ein fester Wert pro Konto (nicht pro Token), den die API nutzt, um Ratenlimits und Tageskontingente anzuwenden. Du erhältst deinen API-Schlüssel beim ersten Erzeugen eines Tokens; jedes weitere Token, das du erzeugst, nutzt denselben Schlüssel erneut.

Die zwei erforderlichen Header

Jede direkte API-Anfrage muss beide der folgenden Header enthalten:

Authorization: Bearer smv_live_...
x-api-key: <dein API-Schlüssel>

Der Header Authorization identifiziert dich; der Header x-api-key ist das, was die API gegen das Ratenlimit und das Tageskontingent deines Kontos prüft.

Ein Token erzeugen Starter+

  1. Gehe zu Einstellungen, unter dem Tab Unternehmen (nur für den Konto-Inhaber oder einen Admin sichtbar).
  2. Wähle unter API-Tokens Neues Token erstellen.
  3. Gib ihm einen Namen — etwas, das dich daran erinnert, wofür es ist, z. B. „CI-Pipeline" oder „Zapier" — und optional ein Ablaufdatum.
  4. Wähle Erstellen. Ein Dialog zeigt dein neues Token und den API-Schlüssel deines Kontos genau einmal. Kopiere beide jetzt — SmoovOps zeigt das vollständige Token danach nie wieder.

Verlierst du ein Token, kannst du es nicht wiederherstellen — widerrufe es und erzeuge stattdessen ein neues.

Ein Token widerrufen

Wähle in derselben Tabelle API-Tokens neben einem Token Widerrufen und bestätige dann. Dies ist endgültig — hast du ein Token versehentlich widerrufen, erzeuge ein neues.

Der Widerruf ist nicht überall sofort wirksam: Eine bereits laufende Anfrage, oder eine, die innerhalb weniger Minuten nach dem Widerruf gestellt wird, kann noch kurzzeitig erfolgreich sein. Änderungen können einige Minuten dauern, bis sie wirksam werden.

Ratenlimits und Kontingente

Wie viele Anfragen pro Sekunde und pro Tag deine Tokens stellen können, hängt von deinem Tarif ab — Pro-Konten erhalten ein höheres Ratenlimit und Tageskontingent als Starter. Anfragen über deinem Tageskontingent, oder zu viele Anfragen zu schnell, erhalten eine Fehlerantwort, bis das Limit zurückgesetzt wird. Kontaktiere das SmoovOps-Support-Team, falls deine Integration ein höheres Limit benötigt, als dein Tarif bietet.

Wer auf die API zugreifen kann

Der API-Zugriff ist in den Tarifen Starter und Pro verfügbar. Er ist im kostenlosen Tarif nicht verfügbar — upgrade über die Einstellungen, um ihn freizuschalten.

Endpunkt-Referenz

Sobald du ein Token hast, findest du in der API-Referenz die vollständige Liste der Endpunkte und was jeder davon im Request-Body erwartet.