Authentifizierung

Die CODEFLUSS API verwendet Bearer Token Authentication für alle geschützten Endpunkte. API-Keys ermöglichen Ihnen den programmatischen Zugriff auf Ihre Projekte, Websites und Design-Ressourcen.

API-Key erstellen

Melden Sie sich in Ihrem CODEFLUSS Dashboard an
Navigieren Sie zu Einstellungen → API Keys
Klicken Sie auf Neuen API-Key erstellen
Geben Sie einen beschreibenden Namen ein (z.B. "CI/CD Pipeline" oder "Backup Script")
Wählen Sie die gewünschten Berechtigungen aus
Kopieren Sie den generierten Key – er wird nur einmal angezeigt!

Verwendung

Fügen Sie Ihren API-Key im Authorization Header jeder Anfrage hinzu:

Authorization: Bearer your_api_key_here

cURL Beispiel

curl -X GET "https://api.codefluss.com/v1/projects" \
  -H "Authorization: Bearer cf_live_abc123..." \
  -H "Content-Type: application/json"

JavaScript/TypeScript Beispiel

const response = await fetch("https://api.codefluss.com/v1/projects", {
  method: "GET",
  headers: {
    "Authorization": "Bearer cf_live_abc123...",
    "Content-Type": "application/json",
  },
});

const data = await response.json();

API-Key Formate

CODEFLUSS API-Keys folgen einem strukturierten Format für einfache Identifikation:

Präfix	Umgebung	Beschreibung
`cf_live_`	Production	Produktions-Keys für Live-Daten
`cf_test_`	Staging	Test-Keys für Entwicklungsumgebungen
`cf_dev_`	Development	Lokale Entwicklungs-Keys

Berechtigungen (Scopes)

API-Keys können mit spezifischen Berechtigungen konfiguriert werden:

Scope	Beschreibung
`projects:read`	Projekte lesen
`projects:write`	Projekte erstellen/bearbeiten
`websites:read`	Websites lesen
`websites:write`	Websites erstellen/bearbeiten
`media:read`	Medien lesen
`media:write`	Medien hochladen/löschen
`design:read`	Design System lesen
`design:write`	Design System bearbeiten
`blog:read`	Blog-Inhalte lesen
`blog:write`	Blog-Inhalte bearbeiten

Sicherheitsempfehlungen

API-Keys schützen

Niemals API-Keys in öffentlichen Repositories committen
Verwenden Sie Umgebungsvariablen für die Key-Speicherung
Rotieren Sie Keys regelmäßig (empfohlen: alle 90 Tage)
Nutzen Sie separate Keys für unterschiedliche Anwendungen

Beispiel mit Umgebungsvariablen

# .env (nicht committen!)
CODEFLUSS_API_KEY=cf_live_abc123...

const apiKey = process.env.CODEFLUSS_API_KEY;

const response = await fetch("https://api.codefluss.com/v1/projects", {
  headers: {
    "Authorization": `Bearer ${apiKey}`,
  },
});

Key-Verwaltung

Key widerrufen

Kompromittierte oder nicht mehr benötigte Keys können jederzeit widerrufen werden:

Navigieren Sie zu Einstellungen → API Keys
Finden Sie den betreffenden Key
Klicken Sie auf Widerrufen
Bestätigen Sie die Aktion

Nach dem Widerruf werden alle Anfragen mit diesem Key mit 401 Unauthorized abgelehnt.

Key-Aktivität überwachen

Im Dashboard können Sie die Nutzung Ihrer API-Keys überwachen:

Letzte Verwendung
Anzahl der Anfragen (letzte 24h/7d/30d)
Fehlerrate
Top-Endpunkte

Fehler-Responses

401 Unauthorized

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

Mögliche Ursachen:

API-Key fehlt im Header
API-Key ist ungültig oder widerrufen
API-Key-Format ist inkorrekt

403 Forbidden

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions for this operation",
    "details": {
      "required": "projects:write",
      "provided": ["projects:read"]
    }
  }
}

Mögliche Ursachen:

API-Key hat nicht die erforderlichen Berechtigungen
Ressource gehört zu einer anderen Organisation

Nächste Schritte

Rate Limits – Verstehen Sie die Anfragelimits
Fehlerbehandlung – Umgang mit API-Fehlern
Projekte – Erste API-Anfragen