Профиль және қауіпсіздік

Әдістер, сұрау өрістері және жауаптар.

Толық нұсқаулық

Бөлімде 6 әдіс бар. Қол жеткізу шарттарын, сұрау өрістерін және жауапты көру үшін әдісті ашыңыз.

Әдіс және жол	Сипаттамасы	Қол жеткізу
`PUT /api/v1/user`	Профильді өзгерту	Жеке кабинет токені
`GET /api/v1/user/passkeys`	Passkey тізімі	Жеке кабинет токені
`PUT /api/v1/user/password`	Құпиясөзді өзгерту	Жеке кабинет токені
`GET /api/v1/user/profile`	Профиль, баланс және байланыстар	Жеке кабинет токені
`GET /api/v1/user/totp/status`	2FA (TOTP) күйі	Жеке кабинет токені
`GET /api/v1/user/totp/verification-method`	TOTP тексеру тәсілі	Жеке кабинет токені

PUT /api/v1/user — Профильді өзгерту

Қол жеткізу: жеке кабинет токені

PUT/api/v1/user

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`username`	`string`	жоқ	; null болуы мүмкін
`avatar_url`	`string`	жоқ	; null болуы мүмкін
`balance_notify_enabled`	`boolean`	жоқ	; null болуы мүмкін
`balance_notify_threshold`	`number`	жоқ	; null болуы мүмкін

Сұрау денесінің үлгісі

{
  "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 енгізетін мәніңіз бен оның түрін білдіреді. Мәндерді ауыстырып, тек қажетті міндетті емес өрістерді қалдырыңыз; жолдық маркерлер сандардың, boolean мәндерінің, нысандардың немесе массивтердің орнына жіберілмейді.

Сұрау схемасы: UpdateProfileRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: User, UserProfileResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "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)"
  }
}

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

Ерекшеліктер: операция күйді өзгертеді немесе бір реттік авторизацияны жалғастырады; мысал шартты сипаттайды және орындалмайды.

Ерекшеліктер: кілттердің шығын лимиттері (quota, quota_used) профильде емес, кілттер жауабында келеді. frozen_balance — резервтелген сома, оны бос баланс деп санауға болмайды.

GET /api/v1/user/passkeys — Passkey тізімі

Қол жеткізу: жеке кабинет токені

GET/api/v1/user/passkeys

Оқу; ID алдыңғы жауабыңыздан алынады

curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Сұрау денесі қажет емес. Жоғарыда көрсетілген параметрлерді URL ішінде жіберіңіз.

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: PasskeyCredentialSummary. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "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)"
  }
}

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

Ерекшеліктер: credential navigator.credentials арқылы алынады; session_token begin арқылы алынады. Finish body <=65536 байт; тіркеу мен жою үшін құпиясөз қажет.

PUT /api/v1/user/password — Құпиясөзді өзгерту

Қол жеткізу: жеке кабинет токені

PUT/api/v1/user/password

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`old_password`	`string`	иә	required
`new_password`	`string`	иә	required,min=6

Сұрау денесінің үлгісі

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

Сұрау схемасы: ChangePasswordRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап схемасы, мәндері шартты

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

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

GET /api/v1/user/profile — Профиль, баланс және байланыстар

Қол жеткізу: жеке кабинет токені

GET/api/v1/user/profile

Оқу; ID алдыңғы жауабыңыздан алынады

curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Сұрау денесі қажет емес. Жоғарыда көрсетілген параметрлерді URL ішінде жіберіңіз.

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: User, UserProfileResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "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)"
  }
}

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

GET /api/v1/user/totp/status — 2FA (TOTP) күйі

Қол жеткізу: жеке кабинет токені

GET/api/v1/user/totp/status

Оқу; ID алдыңғы жауабыңыздан алынады

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Сұрау денесі қажет емес. Жоғарыда көрсетілген параметрлерді URL ішінде жіберіңіз.

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: TotpStatusResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

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

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

Ерекшеліктер: secret және setup_token құпия; тексеру TOTP және пайдаланушы баптауларына байланысты.

GET /api/v1/user/totp/verification-method — TOTP тексеру тәсілі

Қол жеткізу: жеке кабинет токені

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

Оқу; ID алдыңғы жауабыңыздан алынады

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Сұрау денесі қажет емес. Жоғарыда көрсетілген параметрлерді URL ішінде жіберіңіз.

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап схемасы, мәндері шартты

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

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

Ерекшеліктер: secret және setup_token құпия; тексеру TOTP және пайдаланушы баптауларына байланысты.

TotpVerificationMethod

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

Сұрақтарыңыз қалды ма? Request ID мен сипаттаманы жіберіңіз — мәселені анықтауға көмектесеміз.Қолдау қызметіне жазу