Profil va xavfsizlik

Metodlar, so‘rov maydonlari va javoblar.

To‘liq qo‘llanma

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

Metod va yo‘l	Tavsif	Kirish huquqi
`PUT /api/v1/user`	Profilni o‘zgartirish	Boshqaruv paneli tokeni
`GET /api/v1/user/passkeys`	Passkey’lar ro‘yxati	Boshqaruv paneli tokeni
`PUT /api/v1/user/password`	Parolni o‘zgartirish	Boshqaruv paneli tokeni
`GET /api/v1/user/profile`	Profil, balans va bog‘lanishlar	Boshqaruv paneli tokeni
`GET /api/v1/user/totp/status`	2FA (TOTP) holati	Boshqaruv paneli tokeni
`GET /api/v1/user/totp/verification-method`	TOTP’ni tekshirish usuli	Boshqaruv paneli tokeni

PUT /api/v1/user — Profilni o‘zgartirish

Kirish: Boshqaruv paneli tokeni

PUT/api/v1/user

JSON / forma maydonlari

Maydon:	Tur	Majburiy	Tekshiruv / tavsif
`username`	`string`	yo‘q	; null bo‘lishi mumkin
`avatar_url`	`string`	yo‘q	; null bo‘lishi mumkin
`balance_notify_enabled`	`boolean`	yo‘q	; null bo‘lishi mumkin
`balance_notify_threshold`	`number`	yo‘q	; null bo‘lishi mumkin

So‘rov tanasi shabloni

{
  "username": "PLACEHOLDER_USERNAME (string)",
  "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
  "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
  "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)"
}

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: UpdateProfileRequest

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: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

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

GET /api/v1/user/passkeys — Passkey’lar ro‘yxati

Kirish: Boshqaruv paneli tokeni

GET/api/v1/user/passkeys

O‘qish; ID oldingi javobingizdan olinadi

curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -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: PasskeyCredentialSummary. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "name": "PLACEHOLDER_NAME (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "backup": "PLACEHOLDER_BACKUP (boolean)"
  }
}

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

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.

PUT /api/v1/user/password — Parolni o‘zgartirish

Kirish: Boshqaruv paneli tokeni

PUT/api/v1/user/password

JSON / forma maydonlari

Maydon:	Tur	Majburiy	Tekshiruv / tavsif
`old_password`	`string`	ha	required
`new_password`	`string`	ha	required,min=6

So‘rov tanasi shabloni

{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

So‘rov sxemasi: ChangePasswordRequest

Javob

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

Javob sxemasi, qiymatlar shartli

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

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.

GET /api/v1/user/profile — Profil, balans va bog‘lanishlar

Kirish: Boshqaruv paneli tokeni

GET/api/v1/user/profile

O‘qish; ID oldingi javobingizdan olinadi

curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -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.

GET /api/v1/user/totp/status — 2FA (TOTP) holati

Kirish: Boshqaruv paneli tokeni

GET/api/v1/user/totp/status

O‘qish; ID oldingi javobingizdan olinadi

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -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: TotpStatusResponse. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli

{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

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

Xususiyatlar: secret va setup_token maxfiy; tekshiruv TOTP va foydalanuvchi sozlamalariga bog‘liq.

GET /api/v1/user/totp/verification-method — TOTP’ni tekshirish usuli

Kirish: Boshqaruv paneli tokeni

GET/api/v1/user/totp/verification-method

O‘qish; ID oldingi javobingizdan olinadi

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -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 sxemasi, qiymatlar shartli

{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

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

Xususiyatlar: secret va setup_token maxfiy; tekshiruv TOTP va foydalanuvchi sozlamalariga bog‘liq.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}

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