Қате кодтары

HitKey құрылымдалған қате жауаптарын қайтарады. Бұл бетте барлық қате кодтары санат бойынша тізімделген.

Жауап форматы

Көптеген қате жауаптары мына құрылымға сәйкес:

{
  "error": "Адамға оқылатын сипаттама",
  "code": "ERROR_CODE"
}

AdonisJS валидация қателері (HTTP 422) массив форматын пайдаланады:

{
  "errors": [
    {
      "message": "Validation failed",
      "rule": "required",
      "field": "email"
    }
  ]
}

Аутентификация қателері

Код	HTTP	Сипаттама
INVALID_CREDENTIALS	401	Қате email немесе құпия сөз
EMAIL_NOT_VERIFIED	401	Email әлі верификацияланбаған

2FA қателері

Код	HTTP	Сипаттама
INVALID_CODE	400	Қате TOTP коды
SETUP_NOT_INITIATED	400	Бұл пайдаланушы үшін 2FA конфигурацияланбаған
NOT_ENABLED	400	2FA қосылмаған (өшіру мүмкін емес)
INVALID_TOKEN	400	Сынақ токені жарамсыз немесе мерзімі аяқталған

Email басқару қателері

Код	HTTP	Сипаттама
EMAIL_ALREADY_IN_USE	400	Email басқа аккаунтқа тіркелген
INVALID_CODE	400	Қате верификация коды
CODE_EXPIRED	400	Верификация кодының мерзімі аяқталған
TOO_MANY_ATTEMPTS	400	Максималды верификация әрекеттері асырылған
EMAIL_NOT_FOUND	404	Email бұл аккаунтпен байланыстырылмаған
EMAIL_NOT_VERIFIED	400	Email әлі верификацияланбаған
ONLY_VERIFIED_EMAIL	400	Жалғыз верификацияланған электрондық пошта мекенжайын жою мүмкін емес

Профиль қателері

Код	HTTP	Сипаттама
USERNAME_INVALID	400	Пайдаланушы аты форматы жарамсыз
USERNAME_RESERVED	400	Пайдаланушы аты жүйемен резервтелген
USERNAME_TAKEN	409	Пайдаланушы аты бұрыннан пайдаланылуда

Тіркелу қателері

Код	HTTP	Сипаттама
EMAIL_ALREADY_VERIFIED	400	Бұл email бұрыннан верификацияланған
INVALID_CODE	400	Қате верификация коды
TOO_MANY_ATTEMPTS	400	Максималды әрекеттер асырылған (жаңа код сұраңыз)
CODE_EXPIRED	400	Верификация кодының мерзімі аяқталған
NO_CODE	400	Бұл email үшін күтілетін верификация жоқ

Құпия сөзді қалпына келтіру қателері

Код	HTTP	Сипаттама
INVALID_TOKEN	400	Қалпына келтіру токені жарамсыз
TOKEN_EXPIRED	400	Қалпына келтіру токенінің мерзімі аяқталған

OAuth қателері

OAuth эндпоинттері құрылымдалған қате кодтарының орнына адамға оқылатын қате хабарламаларын қайтарады:

{
  "error": "Invalid client_id"
}

Жиі кездесетін қате хабарламалары:

Хабарлама	HTTP	Сипаттама
"Invalid client_id"	400	Белгісіз client_id
"redirect_uri doesn't match"	400	redirect_uri тіркелген URI-мен сәйкес келмейді
"Invalid or expired authorization code"	400	Код бұрыннан пайдаланылған немесе мерзімі аяқталған

Жоба қателері

Код	HTTP	Сипаттама
NOT_PROJECT_MEMBER	403	Пайдаланушы жоба мүшесі емес
ALREADY_MEMBER	400	Пайдаланушы бұрыннан жоба мүшесі
CANNOT_TRANSFER_TO_SELF	400	Иелікті өзіңізге беру мүмкін емес
INVITE_ALREADY_EXISTS	400	Бұл email үшін шақыру бұрыннан бар
INVITE_NOT_FOUND	404	Шақыру табылмады
INVITE_EXPIRED	400	Шақыру мерзімі аяқталған
EMAIL_MISMATCH	400	Пайдаланушының email-і шақыру email-іне сәйкес келмейді

HTTP статус кодтары

Статус	Мағынасы
200	Сәтті
201	Жасалды
202	Қабылданды (2FA сынағы)
400	Қате сұраныс / валидация қатесі
401	Аутентификацияланбаған
403	Тыйым салынған (рұқсаттар жеткіліксіз)
404	Табылмады
409	Қайшылық (мысалы, пайдаланушы аты бұрыннан бар)
422	Өңделмейтін нысан (валидация)
429	Тым көп сұраныстар
500	Сервердің ішкі қатесі