Головна › Бібліотека › REST API › Обробка помилок

Обробка помилок

HTTP-коди статусу

API використовує стандартні HTTP-коди для позначення успіху або помилки:

Код Назва Опис
200 OK Запит успішний
201 Created Ресурс успішно створено
400 Bad Request Невірні дані запиту або помилка валідації
401 Unauthorized Потрібна автентифікація або токен недійсний
403 Forbidden Доступ заборонено - недостатньо прав
404 Not Found Ресурс не знайдено
409 Conflict Конфлікт - ресурс вже існує
500 Internal Server Error Внутрішня помилка сервера

Формат відповіді з помилкою

Відповіді з помилками включають повідомлення про помилку та опціональний масив деталей:

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

Помилки автентифікації

Невірні облікові дані

HTTP/1.1 401 Unauthorized

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

Токен закінчився

HTTP/1.1 401 Unauthorized

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

Токен відсутній

HTTP/1.1 401 Unauthorized

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

Помилки валідації

При помилці валідації відповідь включає детальні повідомлення про помилки для кожного поля:

Приклад помилки валідації

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