Zum Inhalt

Authentifizierung

API-Schlüssel für Anwendungen

Die Afi-API verwendet API-Schlüssel zur Authentifizierung von Anfragen. Sie können Ihre API-Schlüssel auf der Registerkarte Apps im Afi Backup-Portal anzeigen und verwalten. Jede Anwendung kann bis zu zwei API-Schlüssel besitzen, damit die Schlüssel unterbrechungsfrei gewechselt werden können.

Warnung

Ihre API-Schlüssel gewähren umfassende Berechtigungen und ermöglichen den Zugriff auf alle Organisationen und Mandanten, in denen Ihre Anwendung installiert ist. Bewahren Sie sie daher sicher auf!

Geben Sie Ihre geheimen API-Schlüssel nicht weiter und speichern Sie sie nicht in öffentlich zugänglichen Bereichen wie GitHub, clientseitigem Code, WhatsApp oder E-Mails.

Autorisierungsheader verwenden

Die Authentifizierung erfolgt über den HTTP-Header Authorization, dessen Wert auf den API-Schlüssel gesetzt wird. Beispiel für eine authentifizierte Anfrage:

curl https://papi.afi.ai/api/v1/tenants/01F000000000000411Z1101G1Y \
   -H 'Authorization: appkey-93f742c166126bbc'

Alle API-Anfragen müssen über HTTPS erfolgen. Aufrufe über unverschlüsseltes HTTP schlagen fehl. API-Anfragen ohne Authentifizierung schlagen ebenfalls mit dem Statuscode 401 fehl.