Рамзҳои хато

HitKey ҷавобҳои хатои сохторманд бармегардонад. Ин саҳифа ҳамаи рамзҳои хаторо аз рӯи категория номбар мекунад.

Формати ҷавоб

Аксари ҷавобҳои хато аз ин сохтор пайравӣ мекунанд:

{
  "error": "Human-readable description",
  "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	Challenge token беэътибор ё мӯҳлаташ гузашта

Хатоҳои идоракунии 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	Нест кардани ягона email-и тасдиқшуда мумкин нест

Хатоҳои профил

Рамз	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-и барқарорсозӣ беэътибор аст
TOKEN_EXPIRED	400	Мӯҳлати token-и барқарорсозӣ гузаштааст

Хатоҳои 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	Code аллакай истифода шуда ё мӯҳлаташ гузашта

Хатоҳои лоиҳа

Рамз	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	Қабул шуд (challenge-и 2FA)
400	Дархости нодуруст / хатои тасдиқ
401	Тасдиқ нашудааст
403	Манъ (иҷозатҳо кофӣ нест)
404	Ёфт нашуд
409	Зиддият (масалан, номи корбарӣ гирифта шудааст)
422	Коркард мумкин нест (тасдиқ)
429	Дархостҳо бисёранд
500	Хатои дохилии сервер