Authentifizierung

Erfahren Sie, wie Sie Ihre API-Anfragen mit API-Schlüsseln authentifizieren.

Überblick #

Die FireCustos API verwendet API-Schlüssel-Authentifizierung. Jede Anfrage muss einen gültigen API-Schlüssel im Authorization-Header enthalten.

API-Schlüssel werden im FireCustos Admin-Panel erstellt:

Melden Sie sich bei FireCustos als Admin oder Kommandant an
Gehen Sie zu Einstellungen → API-Schlüssel
Klicken Sie auf "API-Schlüssel erstellen" und geben Sie einen beschreibenden Namen ein
Kopieren Sie den Schlüssel sofort — er wird nur einmal angezeigt

Important

API keys are prefixed with fc_ and are 68 characters long. The full key is displayed only once at creation — store it securely immediately.

Fügen Sie den API-Schlüssel im Authorization-Header als Bearer-Token ein:

bash

curl -X GET https://app.firecustos.com/api/v1/firefighters \
  -H "Authorization: Bearer fc_your_api_key_here"

API-Schlüssel sind sensible Anmeldedaten. Befolgen Sie diese Best Practices:

Teilen Sie API-Schlüssel niemals in öffentlichen Repositories oder clientseitigem Code
Verwenden Sie Umgebungsvariablen zum Speichern von Schlüsseln
Rotieren Sie Schlüssel regelmäßig — widerrufen Sie alte und erstellen Sie neue
Jeder Schlüssel wird vor der Speicherung SHA-256 gehasht — FireCustos speichert niemals Ihren Klartext-Schlüssel
Setzen Sie wenn möglich Ablaufdaten für Schlüssel

Wenn die Authentifizierung fehlschlägt, gibt die API eine 401 Unauthorized-Antwort zurück:

json

{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Missing or invalid Authorization header."
}

json

{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Invalid API key."
}

json

{
  "status": 401,
  "title": "Unauthorized",
  "detail": "API key has been revoked."
}

json

{
  "status": 401,
  "title": "Unauthorized",
  "detail": "API key has expired."
}