Strona główna › Biblioteka › REST API › Obsługa błędów

Obsługa błędów

Kody stanu HTTP

Interfejs API wykorzystuje standardowe kody stanu HTTP do sygnalizowania powodzenia lub niepowodzenia:

Kod Nazwa Opis
200 OK Żądanie pomyślne
201 Created Zasób został pomyślnie utworzony
400 Bad Request Nieprawidłowe dane żądania lub błąd walidacji
401 Unauthorized Wymagane uwierzytelnienie lub nieprawidłowy token
403 Forbidden Odmowa dostępu – niewystarczające uprawnienia
404 Not Found Nie znaleziono zasobu
409 Conflict Konflikt – zasób już istnieje
500 Internal Server Error Wewnętrzny błąd serwera

Format odpowiedzi na błąd

Odpowiedzi na błędy zawierają komunikat o błędzie i opcjonalną tablicę szczegółów:

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

Błędy uwierzytelniania

Nieprawidłowe dane uwierzytelniające

HTTP/1.1 401 Unauthorized

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

Wygasły token

HTTP/1.1 401 Unauthorized

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

Brakujący token

HTTP/1.1 401 Unauthorized

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

Błędy walidacji

W przypadku niepowodzenia weryfikacji odpowiedź zawiera szczegółowe komunikaty o błędach dla każdego pola:

Przykładowy błąd walidacji

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."
    ]
}