Zum Hauptinhalt springen

Authentifizierung

Alle API-Anfragen müssen mit einer der unterstützten Methoden authentifiziert werden. Dies stellt sicheren Zugriff auf Ihre Kontodaten sicher und verhindert unautorisierte Nutzung.

Authentifizierungsmethoden

API-Schlüssel-Authentifizierung

Die einfachste Methode ist die Verwendung eines API-Schlüssels. Fügen Sie den API-Schlüssel in den Anfrage-Header ein:
Authorization: Bearer YOUR_API_KEY
Beispiel:
GET /api/users
Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

OAuth 2.0

Für erweiterte Integrationen verwenden Sie OAuth 2.0:
  1. Zugriffstoken erhalten: Verwenden Sie den OAuth-Flow, um ein Zugriffstoken zu erhalten
  2. In Anfragen einschließen: Fügen Sie das Token in den Authorization-Header ein
  3. Token aktualisieren: Behandeln Sie Token-Ablauf durch Aktualisierung bei Bedarf
Beispiel:
POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

Basis-Authentifizierung

Für Testzwecke wird Basis-Authentifizierung unterstützt:
Authorization: Basic BASE64_ENCODED_CREDENTIALS
Wobei BASE64_ENCODED_CREDENTIALS die Base64-Codierung von username:password ist.

Sicherheits-Best Practices

  • Schlüssel sicher speichern: Nie API-Schlüssel in Client-seitigem Code freigeben oder protokollieren
  • HTTPS verwenden: Immer Anfragen über HTTPS stellen
  • Schlüssel regelmäßig rotieren: API-Schlüssel periodisch für Sicherheit ändern
  • Nutzung überwachen: API-Schlüssel-Nutzung verfolgen, um Anomalien zu erkennen

Fehlerantworten

Wenn die Authentifizierung fehlschlägt, gibt die API zurück:
{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}