Dokumentation | API-Referenz

HTTP-Statuscodes

Die API verwendet Standard-HTTP-Codes zur Kennzeichnung von Erfolg oder Fehler:

Code	Name	Beschreibung
200	OK	Anfrage erfolgreich
201	Created	Ressource erfolgreich erstellt
400	Bad Request	Ungültige Anfragedaten oder Validierungsfehler
401	Unauthorized	Authentifizierung erforderlich oder Token ungültig
403	Forbidden	Zugriff verweigert - unzureichende Rechte
404	Not Found	Ressource nicht gefunden
409	Conflict	Konflikt - Ressource existiert bereits
500	Internal Server Error	Interner Serverfehler

Fehlerantwort-Format

Fehlerantworten enthalten eine Fehlermeldung und optional ein Array mit Details:

{
    "error": "Validation failed",
    "details": [
        "email: This value is not a valid email address.",
        "password: Password must be at least 8 characters."
    ]
}

Authentifizierungsfehler

Ungültige Anmeldedaten

HTTP/1.1 401 Unauthorized

{
    "code": 401,
    "message": "Invalid credentials."
}

Token abgelaufen

HTTP/1.1 401 Unauthorized

{
    "code": 401,
    "message": "Expired JWT Token"
}

Token fehlt

HTTP/1.1 401 Unauthorized

{
    "code": 401,
    "message": "JWT Token not found"
}

Validierungsfehler

Bei Validierungsfehlern enthält die Antwort detaillierte Fehlermeldungen für jedes Feld:

Beispiel für Validierungsfehler

HTTP/1.1 400 Bad Request

{
    "error": "Validation failed",
    "details": [
        "name: This value should not be blank.",
        "email: This value is not a valid email address.",
        "password: Password must contain at least one uppercase letter."
    ]
}

Fehlerbehandlung