hujjatlar
Boshqaruv paneli API

Kirish va seanslar

Markdown

Metodlar, so‘rov maydonlari va javoblar.

To‘liq qo‘llanma

Bo‘limda 14 ta metod bor. Kirish shartlari, so‘rov maydonlari va javobni ko‘rish uchun metodni oching.

Metod va yo‘lTavsifKirish huquqi
POST /api/v1/auth/forgot-passwordParolni tiklash so‘roviTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/loginElektron pochta va parol bilan kirishTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/login/2faTOTP orqali kirishni yakunlashTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/logoutChiqish va yangilash tokenini bekor qilishTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
GET /api/v1/auth/meJoriy foydalanuvchi, balans va limitlarBoshqaruv paneli tokeni
POST /api/v1/auth/passkey/login/beginPasskey orqali kirishni boshlashTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/passkey/login/finishPasskey orqali kirishni yakunlashTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/refreshTokenlarni yangilashTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/registerRo‘yxatdan o‘tishTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/reset-passwordParolni tiklashTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/revoke-all-sessionsBarcha seanslarni bekor qilishBoshqaruv paneli tokeni
POST /api/v1/auth/send-verify-codeTasdiqlash kodini yuborishTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/validate-invitation-codeTaklifni tekshirishTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/validate-promo-codePromokodni tekshirishTizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan
POST /api/v1/auth/forgot-password — Parolni tiklash so‘rovi

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 5 ta so‘rov.

POST/api/v1/auth/forgot-password

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
emailstringharequired,email
turnstile_tokenstringyo‘q
So‘rov tanasi shabloni
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: ForgotPasswordRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: ForgotPasswordResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/login — Elektron pochta va parol bilan kirish

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 20 ta so‘rov.

POST/api/v1/auth/login

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
emailstringharequired,email
passwordstringharequired
turnstile_tokenstringyo‘q
So‘rov tanasi shabloni
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: LoginRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: TotpLoginResponse, User, AuthResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javobning bir necha varianti mumkin bo‘lsa, ularning maydonlari alohida sxemalarda sanalgan; ularni bitta obyektga birlashtirmang.

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/login/2fa — TOTP orqali kirishni yakunlash

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 20 ta so‘rov.

POST/api/v1/auth/login/2fa

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
temp_tokenstringharequired
totp_codestringharequired,len=6
So‘rov tanasi shabloni
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: Login2FARequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: User, AuthResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javobning bir necha varianti mumkin bo‘lsa, ularning maydonlari alohida sxemalarda sanalgan; ularni bitta obyektga birlashtirmang.

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/logout — Chiqish va yangilash tokenini bekor qilish

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

POST/api/v1/auth/logout

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
refresh_tokenstringyo‘q; Ixtiyoriy: ko‘rsatilgan yangilash tokenini bekor qilish
So‘rov tanasi shabloni
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: LogoutRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: LogoutResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

GET /api/v1/auth/me — Joriy foydalanuvchi, balans va limitlar

Kirish: Boshqaruv paneli tokeni

GET/api/v1/auth/me
O‘qish; ID oldingi javobingizdan olinadi
curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"

So‘rov tanasi talab qilinmaydi. Yuqoridagi parametrlarni URL orqali uzating.

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: User, UserProfileResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

Xususiyatlar: Barcha shaxsiy ma’lumotlar va obyektlar JWT subyekti bilan cheklangan.

Xususiyatlar: kalitlarning sarf limitlari (quota, quota_used) profilda emas, kalitlar javobida keladi. frozen_balance — zaxiraga olingan summa; uni erkin balans deb hisoblash mumkin emas.

POST /api/v1/auth/passkey/login/begin — Passkey orqali kirishni boshlash

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 20 ta so‘rov.

POST/api/v1/auth/passkey/login/begin

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
turnstile_tokenstringyo‘q
So‘rov tanasi shabloni
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: PasskeyBeginLoginRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: PasskeyOptionsResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

Xususiyatlar: credential navigator.credentials’dan, session_token esa begin’dan olinadi. Finish body <=65536 bayt; passkey’ni ro‘yxatga olish va o‘chirish parolni talab qiladi.

POST /api/v1/auth/passkey/login/finish — Passkey orqali kirishni yakunlash

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 20 ta so‘rov.

POST/api/v1/auth/passkey/login/finish

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
session_tokenstringharequired
namestringyo‘q
credentialobjectharequired
So‘rov tanasi shabloni
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: PasskeyFinishRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: User, AuthResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javobning bir necha varianti mumkin bo‘lsa, ularning maydonlari alohida sxemalarda sanalgan; ularni bitta obyektga birlashtirmang.

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

Xususiyatlar: credential navigator.credentials’dan, session_token esa begin’dan olinadi. Finish body <=65536 bayt; passkey’ni ro‘yxatga olish va o‘chirish parolni talab qiladi.

POST /api/v1/auth/refresh — Tokenlarni yangilash

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 30 ta so‘rov.

POST/api/v1/auth/refresh

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
refresh_tokenstringharequired
So‘rov tanasi shabloni
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: RefreshTokenRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: RefreshTokenResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
    "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
    "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
    "token_type": "PLACEHOLDER_TOKEN_TYPE (string)"
  }
}

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/register — Ro‘yxatdan o‘tish

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 5 ta so‘rov.

POST/api/v1/auth/register

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
emailstringharequired,email
passwordstringharequired,min=6
verify_codestringyo‘q
turnstile_tokenstringyo‘q
promo_codestringyo‘q; Ro‘yxatdan o‘tish promokodi
invitation_codestringyo‘q; Taklif kodi
So‘rov tanasi shabloni
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "verify_code": "PLACEHOLDER_VERIFY_CODE (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)",
  "promo_code": "PLACEHOLDER_PROMO_CODE (string)",
  "invitation_code": "PLACEHOLDER_INVITATION_CODE (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: RegisterRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: User, AuthResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javobning bir necha varianti mumkin bo‘lsa, ularning maydonlari alohida sxemalarda sanalgan; ularni bitta obyektga birlashtirmang.

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/reset-password — Parolni tiklash

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 10 ta so‘rov.

POST/api/v1/auth/reset-password

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
emailstringharequired,email
tokenstringharequired
new_passwordstringharequired,min=6
So‘rov tanasi shabloni
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: ResetPasswordRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: ResetPasswordResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/revoke-all-sessions — Barcha seanslarni bekor qilish

Kirish: Boshqaruv paneli tokeni

POST/api/v1/auth/revoke-all-sessions

So‘rov tanasi talab qilinmaydi.

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: RevokeAllSessionsResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Xususiyatlar: Barcha shaxsiy ma’lumotlar va obyektlar JWT subyekti bilan cheklangan.

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/send-verify-code — Tasdiqlash kodini yuborish

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 5 ta so‘rov.

POST/api/v1/auth/send-verify-code

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
emailstringharequired,email
turnstile_tokenstringyo‘q
So‘rov tanasi shabloni
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: SendVerifyCodeRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: SendVerifyCodeResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/validate-invitation-code — Taklifni tekshirish

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 10 ta so‘rov.

POST/api/v1/auth/validate-invitation-code

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
codestringharequired
So‘rov tanasi shabloni
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: ValidateInvitationCodeRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: ValidateInvitationCodeResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}

Xususiyatlar: Metod taklifni tekshiradi va kodni ishlatib yubormaydi; misol API shartnomasini tavsiflaydi va bajarilmaydi.

POST /api/v1/auth/validate-promo-code — Promokodni tekshirish

Kirish: tizimga kirmasdan; qo‘shimcha shartlar metod tavsifida berilgan

Funksiyaning mavjudligi va qo‘shimcha kirish shartlari so‘rov bajarilganda tekshiriladi.

So‘rovlar chastotasi limiti: bitta manzildan 60 soniyada 10 ta so‘rov.

POST/api/v1/auth/validate-promo-code

JSON / forma maydonlari

Maydon: TurMajburiyTekshiruv / tavsif
codestringharequired
So‘rov tanasi shabloni
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: ValidatePromoCodeRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: ValidatePromoCodeResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "bonus_amount": "PLACEHOLDER_BONUS_AMOUNT (number)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)",
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Xususiyatlar: Metod promokodni tekshiradi va bonusni hisobga qo‘shmaydi; misol API shartnomasini tavsiflaydi va bajarilmaydi.

Kirish va seanslar · 2FA

POST /api/v1/auth/login → data

  • data.requires_2fa === true → TotpLoginResponse → data.temp_token → POST /api/v1/auth/login/2fa · {"temp_token": "…", "totp_code": "…"} → data.access_token
  • data.access_token → AuthResponse → Authorization: Bearer $TOKEN

totp_code: string, len = 6. temp_token ≠ access_token. User

Savollaringiz qoldimi? Request ID va tavsifni yuboring — tushunishga yordam beramiz.Yordam xizmatiga yozish