Zum Inhalt

Authentifizierung

API-Schlüssel für Anwendungen

Die Afi-API authentifiziert Anforderungen mit API-Schlüsseln. Sie können Ihre API-Schlüssel auf der Registerkarte Apps im Afi-Portal anzeigen und verwalten. Jede Anwendung (Application) kann bis zu zwei API-Schlüssel haben, damit Sie die Schlüssel ohne Unterbrechung wechseln 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 die Schlüssel 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.

HTTP-Header Authorization verwenden

Zur Authentifizierung wird der API-Schlüssel im HTTP-Header Authorization übermittelt. Beispiel für eine authentifizierte Anforderung:

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

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