Skip to Content
DokumentationAuthentifizierung

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung über einen API Key. OfoxAI verwendet einen einheitlichen API Key, der für alle drei Protokolle funktioniert.

API Key erhalten

  1. Registrieren Sie sich und melden Sie sich bei der OfoxAI-Konsole  an
  2. Gehen Sie zu EinstellungenAPI Keys
  3. Klicken Sie auf Neuen Schlüssel erstellen
  4. Kopieren und speichern Sie Ihren API Key sicher

Der API Key wird nur einmalig bei der Erstellung angezeigt. Stellen Sie sicher, dass Sie ihn sicher speichern. Bei Verlust müssen Sie einen neuen erstellen.

Authentifizierungsmethoden

Die Authentifizierungsmethode unterscheidet sich je nach verwendetem Protokoll:

Das OpenAI-kompatible Protokoll verwendet den Authorization-Header:

Authorization: Bearer <Ihr OFOXAI_API_KEY>
from openai import OpenAI client = OpenAI( base_url="https://api.ofox.ai/v1", api_key="<Ihr OFOXAI_API_KEY>" )

Umgebungsvariablen-Konfiguration

Wir empfehlen die Verwendung von Umgebungsvariablen zur Verwaltung Ihres API Keys, um Hardcoding zu vermeiden:

.env
OFOX_API_KEY=<Ihr OFOXAI_API_KEY> # Sie können auch protokollspezifische Umgebungsvariablen setzen OPENAI_API_KEY=<Ihr OFOXAI_API_KEY> OPENAI_BASE_URL=https://api.ofox.ai/v1 ANTHROPIC_API_KEY=<Ihr OFOXAI_API_KEY> ANTHROPIC_BASE_URL=https://api.ofox.ai/anthropic GEMINI_API_KEY=<Ihr OFOXAI_API_KEY> GEMINI_BASE_URL=https://api.ofox.ai/gemini

Sicherheits-Best-Practices

  1. Umgebungsvariablen verwenden — Codieren Sie API Keys niemals direkt in Ihren Quellcode
  2. Schlüssel regelmäßig rotieren — Wir empfehlen eine Rotation alle 90 Tage
  3. Umgebungen trennen — Verwenden Sie verschiedene API Keys für Entwicklung und Produktion
  4. Nutzung überwachen — Überprüfen Sie regelmäßig die API-Nutzung und auffällige Aufrufe in der Konsole
  5. Berechtigungen einschränken — Erstellen Sie separate API Keys für verschiedene Projekte zur einfacheren Nachverfolgung und Verwaltung

Committen Sie niemals API Keys in Git-Repositories und setzen Sie sie nicht in clientseitigem Code ein. Verwenden Sie .gitignore, um .env-Dateien auszuschließen.

Last updated on