Zum Hauptinhalt springen
Alle Anfragen an die Aniva Partner-API müssen deinen Partner-API-Schlüssel im Request-Header x-api-key enthalten.
Kontaktiere Aniva, um deinen API-Schlüssel zu erhalten. Schlüssel werden pro Partnerkonto ausgestellt.

Authentifizierte Anfragen senden

Sende den x-api-key-Header bei jeder Anfrage an die API mit.

Fehlerantworten

Wenn deine Anfrage keinen x-api-key-Header enthält, antwortet die API mit 401 Unauthorized.
Wenn der API-Schlüssel ungültig ist, antwortet die API mit 401 Unauthorized.
Wenn der Schlüssel gültig ist, aber nicht den Scope für den Endpunkt hat, antwortet die API mit 403 Forbidden.
Wenn du einen dieser Fehler erhältst, prüfe Folgendes:
  1. Deine Anfrage enthält den x-api-key-Header.
  2. Der Wert des API-Schlüssels ist korrekt und wurde nicht rotiert.
  3. Dein Schlüssel hat den Scope, den der Endpunkt benötigt. Jeder Endpunkt in der API-Referenz nennt seinen Scope.
Gib deinen API-Schlüssel niemals in clientseitigem Code oder öffentlichen Repositories preis. Behandle ihn wie ein Passwort.
Kontaktiere Aniva, um einen kompromittierten Schlüssel zu rotieren oder Änderungen an den Berechtigungen deines API-Schlüssels anzufordern.