Zum Inhalt

API Key Management

API Keys sind essentiell für die Authentifizierung Ihrer Anfragen an die Elluminate-Plattform. Diese Anleitung behandelt Best Practices für die sichere Verwaltung Ihrer API Keys. Achtung: Nur Projekt-Admins haben Zugriff auf das "API Keys" Dashboard.

API Keys erstellen

  • Navigieren Sie zum "API Keys" Dashboard Ihres Projekts

API Keys Dashboard

  • Klicken Sie auf "Create new secret key"
  • Geben Sie einen beschreibenden Namen für Ihren Key ein
  • Legen Sie ein Ablaufdatum fest (empfohlen) oder wählen Sie "never" für kein Ablaufdatum

Create API Key

  • Speichern Sie Ihren Key sicher - er wird nur einmal angezeigt

Created API Key

Sicherheits-Best-Practices

Sichere Speicherung

  • Verwenden Sie Environment Variables zur Speicherung von API Keys
  • Committen Sie niemals API Keys in die Versionskontrolle
  • Legen Sie Keys nicht in Client-seitigem Code oder im Browser offen
  • Halten Sie Keys aus Logs und Fehlermeldungen heraus

Regelmäßige Rotation

  • Rotieren Sie Keys nach einem regelmäßigen Zeitplan
  • Erstellen Sie neue Keys, bevor alte ablaufen
  • Entfernen Sie ungenutzte oder abgelaufene Keys
  • Verwenden Sie wenn möglich Ablaufdaten

Zugriffskontrolle

  • Verwenden Sie beschreibende Namen zur Nachverfolgung der Key-Nutzung
  • Widerrufen Sie kompromittierte Keys sofort
  • Überwachen Sie die Key-Nutzung über das Dashboard

Bestehende Keys verwalten

Vom Keys Dashboard aus können Sie:

  • Alle aktiven API Keys anzeigen
  • Sehen, wann Keys zuletzt verwendet wurden
  • Ablaufdaten überprüfen
  • Key-Namen bearbeiten
  • Keys löschen/widerrufen

API Keys verwenden

Sie können Ihren API Key als Umgebungsvariable exportieren:

export ELLUMINATE_API_KEY=<your_api_key>

Oder Sie können den API Key als Parameter in der Client-Klasse setzen:

from elluminate import Client

client = Client(api_key="<your_api_key>")

Für weitere Details zur Verwendung des SDK, siehe unsere Quick Start Guide.

Fehlerbehebung

Wenn Sie Probleme mit Ihrem API Key haben:

  • Überprüfen Sie, ob der Key nicht abgelaufen ist
  • Überprüfen Sie, ob der Key widerrufen wurde
  • Stellen Sie sicher, dass Sie den richtigen Projekt-ID verwenden
  • Stellen Sie sicher, dass der Key korrekt in Anfragen gesendet wird