Skip to content
API находится в стадии beta и может измениться без предварительного уведомления.

Коды ошибок

HitKey возвращает структурированные ответы об ошибках. На этой странице перечислены все коды по категориям.

Формат ответа

Основной формат ошибок:

json
{
  "error": "Описание ошибки",
  "code": "ERROR_CODE"
}

Ошибки валидации AdonisJS (HTTP 422) используют формат массива:

json
{
  "errors": [
    {
      "message": "Ошибка валидации",
      "rule": "required",
      "field": "email"
    }
  ]
}

Ошибки аутентификации

КодHTTPОписание
INVALID_CREDENTIALS401Неверный email или пароль
EMAIL_NOT_VERIFIED401Email ещё не верифицирован

Ошибки 2FA

КодHTTPОписание
INVALID_CODE400Неверный TOTP-код
SETUP_NOT_INITIATED4002FA не настроена
NOT_ENABLED4002FA не включена
INVALID_TOKEN400Недействительный или истёкший challenge token

Ошибки управления email

КодHTTPОписание
EMAIL_ALREADY_IN_USE400Email занят другим аккаунтом
INVALID_CODE400Неверный код верификации
CODE_EXPIRED400Код верификации истёк
TOO_MANY_ATTEMPTS400Превышено количество попыток
EMAIL_NOT_FOUND404Email не связан с аккаунтом
EMAIL_NOT_VERIFIED400Email не верифицирован
ONLY_VERIFIED_EMAIL400Нельзя удалить единственный верифицированный email

Ошибки профиля

КодHTTPОписание
USERNAME_INVALID400Неверный формат username
USERNAME_RESERVED400Username зарезервирован системой
USERNAME_TAKEN409Username уже занят

Ошибки регистрации

КодHTTPОписание
EMAIL_ALREADY_VERIFIED400Email уже верифицирован
INVALID_CODE400Неверный код
TOO_MANY_ATTEMPTS400Превышено количество попыток
CODE_EXPIRED400Код истёк
NO_CODE400Нет ожидающей верификации

Ошибки сброса пароля

КодHTTPОписание
INVALID_TOKEN400Недействительный токен
TOKEN_EXPIRED400Токен истёк

Ошибки OAuth

OAuth-эндпоинты возвращают текстовые сообщения об ошибках:

json
{
  "error": "Invalid client_id"
}
СообщениеHTTPОписание
"Invalid client_id"400Неизвестный client_id
"redirect_uri doesn't match"400redirect_uri не совпадает
"Invalid or expired authorization code"400Код уже использован или истёк

Ошибки проектов

КодHTTPОписание
NOT_PROJECT_MEMBER403Пользователь не участник проекта
ALREADY_MEMBER400Пользователь уже участник
CANNOT_TRANSFER_TO_SELF400Нельзя передать владение себе
INVITE_ALREADY_EXISTS400Приглашение для этого email уже существует
INVITE_NOT_FOUND404Приглашение не найдено
INVITE_EXPIRED400Приглашение истекло
EMAIL_MISMATCH400Email пользователя не совпадает с email приглашения

HTTP-статусы

СтатусЗначение
200Успех
201Создано
202Принято (2FA challenge)
400Ошибка запроса / валидации
401Не аутентифицирован
403Запрещено (недостаточно прав)
404Не найдено
409Конфликт (например, username занят)
422Ошибка валидации
429Слишком много запросов
500Внутренняя ошибка сервера

HitKey Service License.