الملف الشخصي والأمان

الطرق وحقول الطلبات والردود.

الدليل الكامل

يضم القسم 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 لا يتجاوز 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 ووصفاً للمشكلة وسنساعدك على فهمها.مراسلة الدعم