API-Schlüssel

API-Schlüssel ermöglichen den programmatischen Zugriff auf Levy Fleets-Daten und -Funktionen. Erstellen Sie Schlüssel für benutzerdefinierte Integrationen, Datenexporte und Drittanbieteranwendungen.

Übersicht

Was API-Schlüssel ermöglichen

API-Schlüssel erlauben:

• Programmatischen Datenzugriff
• Drittanbieter-Integrationen
• Benutzerdefinierte Berichtswerkzeuge
• Automatisierte Workflows
• Mobile App-Entwicklung

Authentifizierungsablauf

1. Anfrage enthält API-Schlüssel-Header
2. Schlüssel wird validiert
3. Berechtigungen werden geprüft
4. Anfrage wird verarbeitet
5. Antwort wird zurückgegeben

API-Schlüssel erstellen

Schritt für Schritt

1. Navigieren Sie zu Einstellungen > API-Schlüssel
2. Klicken Sie auf API-Schlüssel erstellen
3. Konfigurieren Sie den Schlüssel:
   • Name (zur Identifikation)
   • Berechtigungen
   • Ablaufdatum (optional)
4. Klicken Sie auf Erstellen
5. Kopieren Sie den Schlüssel sofort

Schlüsselkonfiguration

Best Practices für Benennung

Verwenden Sie beschreibende Namen:

• Production-Analytics-Integration
• Staging-Mobile-App
• Partner-XYZ-Access
• Internal-Reporting-Tool

Berechtigungen

Berechtigungsstufen

Ressourcenberechtigungen

Konfigurieren Sie den Zugriff pro Ressource:

Beispiel-Berechtigungssätze

Analyse-Integration:

• Fahrten: Lesen
• Fahrzeuge: Lesen
• Kunden: Lesen
• Analysen: Lesen

Mobile App:

• Fahrten: Lesen, Erstellen, Aktualisieren
• Fahrzeuge: Lesen
• Kunden: Lesen, Aktualisieren

Admin-Werkzeug:

• Alle Ressourcen: Vollzugriff

API-Schlüssel verwenden

HTTP-Header

Fügen Sie den Schlüssel im Authorization-Header ein:

Authorization: Bearer YOUR_API_KEY

Beispielanfrage

curl -X GET "https://api.levyfleets.com/v1/rides" \
  -H "Authorization: Bearer sk_live_abc123..." \
  -H "Content-Type: application/json"

Basis-URL

Production: https://api.levyfleets.com/v1 Sandbox: https://api-sandbox.levyfleets.com/v1

Schlüsseltypen

Live-Schlüssel

Für Produktionsnutzung:

• Präfix: sk_live_
• Zugriff auf Produktionsdaten
• Beeinflusst echte Vorgänge
• In Produktionssystemen verwenden

Test-Schlüssel

Für Entwicklung/Tests:

• Präfix: sk_test_
• Zugriff auf Sandbox-Umgebung
• Sicher zum Testen
• Keine echten Daten betroffen

Schlüssel verwalten

Schlüssel anzeigen

Die API-Schlüssel-Seite zeigt:

• Schlüsselname
• Teilschlüssel (letzte 8 Zeichen)
• Berechtigungszusammenfassung
• Zuletzt verwendet
• Status

Schlüssel bearbeiten

Vorhandene Schlüssel ändern:

1. Auf den Schlüssel klicken
2. Name oder Berechtigungen aktualisieren
3. Änderungen speichern

Schlüssel widerrufen

Um einen Schlüssel zu deaktivieren:

1. Auf den Schlüssel klicken
2. Widerrufen klicken
3. Widerruf bestätigen

Widerrufene Schlüssel:

• Funktionieren sofort nicht mehr
• Können nicht reaktiviert werden
• Bleiben zur Prüfung in der Liste

Schlüssel löschen

Zum dauerhaften Entfernen:

1. Auf den Schlüssel klicken
2. Löschen klicken
3. Löschung bestätigen

Gelöschte Schlüssel:

• Aus der Liste entfernt
• Können nicht wiederhergestellt werden
• Prüfprotokoll bleibt erhalten

Rate-Limiting

Standardlimits

Rate-Limit-Header

Antwort enthält:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 55
X-RateLimit-Reset: 1640000000

Rate-Limits handhaben

Bei Überschreitung des Limits:

• HTTP 429 Antwort
• Retry-After Header
• Exponentielles Backoff implementieren

Sicherheits-Best-Practices

Schlüsselspeicherung

• Schlüssel niemals in Versionskontrolle einchecken
• Umgebungsvariablen verwenden
• In Secrets-Manager speichern
• Schlüssel regelmäßig rotieren

Schlüsselrotation

Schlüssel regelmäßig rotieren:

1. Neuen Schlüssel erstellen
2. Ihre Systeme aktualisieren
3. Mit neuem Schlüssel testen
4. Alten Schlüssel widerrufen

Überwachung

Schlüsselnutzung verfolgen:

• Anfragevolumen überwachen
• Auf ungewöhnliche Muster achten
• Alarme einrichten
• Zugriffsprotokolle überprüfen

Prinzip der geringsten Berechtigung

• Nur minimal benötigte Berechtigungen gewähren
• Separate Schlüssel pro Integration verwenden
• Schlüssel nicht zwischen Umgebungen teilen
• Ungenutzte Schlüssel widerrufen

API-Schlüssel-Bereiche

Unterkonto-Bereiche

Schlüssel auf bestimmte Unterkonten beschränken:

• Alle Unterkonten
• Nur bestimmte Unterkonten
• Einzelnes Unterkonto

IP-Einschränkungen

Schlüsselnutzung nach IP einschränken:

1. Auf den Schlüssel klicken
2. Erlaubte IPs hinzufügen
3. Änderungen speichern

Nur Anfragen von gelisteten IPs funktionieren.

Fehlerbehebung

Authentifizierung fehlgeschlagen

401 Unauthorized Antwort:

1. Prüfen Sie, ob der Schlüssel korrekt ist
2. Prüfen Sie, ob der Schlüssel nicht widerrufen wurde
3. Authorization-Header-Format bestätigen
4. Prüfen Sie, ob der Schlüssel nicht abgelaufen ist

Zugriff verweigert

403 Forbidden Antwort:

1. Schlüsselberechtigungen überprüfen
2. Ressourcenzugriff prüfen
3. Unterkonto-Bereich verifizieren
4. IP-Erlaubnisliste bestätigen

Rate-Limited

429 Too Many Requests:

1. Rate-Limit-Header prüfen
2. Backoff implementieren
3. Limiterhöhung anfordern
4. Anfragemuster optimieren

Schlüssel funktioniert nicht

Wenn der Schlüssel nicht mehr funktioniert:

1. Schlüsselstatus im Dashboard prüfen
2. Prüfen, ob der Schlüssel nicht widerrufen wurde
3. Auf Ablauf prüfen
4. Mit neuem Schlüssel testen

API-Dokumentation

Zugriff auf Dokumentation

Vollständige API-Dokumentation verfügbar unter:

• https://docs.levyfleets.com/api
• Swagger/OpenAPI Spezifikation
• Interaktiver API-Explorer

Verfügbare Endpunkte

SDKs

Offizielle SDKs verfügbar:

• JavaScript/TypeScript
• Python
• Ruby
• PHP

---