Authentifizierung für Entwickler

Dieser Leitfaden zeigt Ihnen, wie Sie Ihre Famulor API-Anfragen korrekt authentifizieren und dabei Best Practices für Sicherheit und Fehlerbehebung befolgen.
Für eine schnelle Referenz siehe unsere grundlegende Authentifizierungsseite in der API-Referenz.

Überblick

Die Famulor API verwendet Bearer Token-Authentifizierung mit API-Schlüsseln. Jeder API-Aufruf muss einen gültigen API-Schlüssel im Authorization Header enthalten.

API-Schlüssel erhalten

1

Dashboard öffnen

Melden Sie sich bei Ihrem Famulor-Konto an unter https://app.famulor.de
2

API-Schlüssel Seite

Navigieren Sie zur “API-Schlüssel” Seite in Ihrem Dashboard
3

Schlüssel erstellen

Klicken Sie auf “Neuen API-Schlüssel erstellen”
4

Sicher speichern

Kopieren Sie den Schlüssel sofort und speichern Sie ihn sicher ab - er wird nur einmal angezeigt
Wichtige Sicherheitshinweise:
  • Halten Sie Ihren API-Schlüssel vertraulich und sicher
  • Teilen Sie ihn niemals öffentlich oder in Code-Repositories
  • Rotieren Sie Schlüssel regelmäßig (empfohlen: alle 90 Tage)
  • Verwenden Sie Umgebungsvariablen für die Speicherung

API-Schlüssel verwenden

Standard-Authentifizierung

Fügen Sie Ihren API-Schlüssel in den Authorization Header jeder Anfrage ein:
Authorization: Bearer YOUR_API_KEY

Code-Beispiele

// Umgebungsvariable verwenden
const API_KEY = process.env.FAMULOR_API_KEY;

const response = await fetch('https://app.famulor.de/api/user/assistants', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

Umgebungsvariablen Setup

Lokal (.env Datei)

# .env Datei
FAMULOR_API_KEY=your_actual_api_key_here

Production Deployment

heroku config:set FAMULOR_API_KEY=your_actual_api_key_here

Authentifizierungs-Fehlerbehandlung

Häufige Fehler und Lösungen

Authentifizierung testen

Einfacher Test-Aufruf

curl -X GET "https://app.famulor.de/api/user/assistants" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"

Erwartete Antwort

{
  "assistants": [
    {
      "id": 123,
      "name": "Mein Assistent",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Best Practices für Sicherheit

✅ Empfohlene Praktiken

  • Umgebungsvariablen für API-Schlüssel verwenden
  • HTTPS für alle API-Aufrufe nutzen
  • Schlüsselrotation regelmäßig durchführen
  • Minimale Berechtigungen anwenden
  • Logging von API-Aufrufen ohne Schlüssel-Preisgabe

❌ Vermeiden Sie

  • API-Schlüssel im Code hart codieren
  • Schlüssel in Versionskontrollsysteme committen
  • Schlüssel über unsichere Kanäle übertragen
  • Schlüssel in Client-seitigem JavaScript verwenden
  • Schlüssel in URL-Parametern übertragen

Rate Limiting

Die Famulor API implementiert Rate Limiting zum Schutz der Infrastruktur:
  • Standard-Limit: 100 Anfragen pro Minute
  • Burst-Limit: 20 Anfragen pro 10 Sekunden

Rate Limit Headers

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

Rate Limit überschritten

{
  "error": "Rate limit exceeded",
  "message": "Too many requests. Please try again later.",
  "retry_after": 60
}

Nächste Schritte

Beginnen Sie mit einem einfachen Test-Aufruf, um sicherzustellen, dass Ihre Authentifizierung korrekt funktioniert, bevor Sie komplexere Integrationen implementieren.