API-Authentifizierung

Alle API-Anfragen an SilentShield erfordern eine Authentifizierung. Es gibt zwei Authentifizierungsmethoden je nach Endpunkt.

API-Key-Authentifizierung

Die meisten Endpunkte verwenden API-Key-Authentifizierung über den X-Api-Key Header. Ihr API-Key ist im Dashboard unter API-Keys verfügbar.

X-Api-Key: ihr-api-key-hier

Verwenden Sie diese Methode für: Widget-Endpunkte, Nonce-Verifizierung und öffentliche API-Aufrufe.

JWT-Authentifizierung

Dashboard- und Management-Endpunkte verwenden JWT (JSON Web Token) Authentifizierung. Erhalten Sie ein Token durch Anmeldung über den Auth-Endpunkt.

POST /api/v1/auth/login

Request Body:

{"email": "[email protected]", "password": "ihr-passwort"}

Response:

{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Verwenden Sie diese Methode für: Management-Endpunkte, Analyse-Abfragen, Team-Verwaltung und Kontoeinstellungen.

Authentifizierungsfehler

StatusErrorSolution
401missing credentialsFügen Sie den X-Api-Key oder Authorization Header hinzu.
401invalid_api_keyPrüfen Sie, ob Ihr API-Key korrekt und aktiv ist.
401token_expiredIhr JWT ist abgelaufen. Fordern Sie ein neues Token über /api/v1/auth/login an.
403insufficient_permissionsIhre Rolle hat keinen Zugriff auf diesen Endpunkt.

Rate-Limits

API-Anfragen sind pro API-Schlüssel und Endpunkt ratenlimitiert. Wie viele Anfragen pro Minute erlaubt sind, richtet sich nach Ihrem Tarif — die Werte stehen auf der Preisseite. Jede Antwort enthält die Rate-Limit-Header.

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After (nur bei 429)