docs
แผงควบคุม
API แผงควบคุม

โปรไฟล์และความปลอดภัย

Markdown

เมธอด ฟิลด์คำขอ และคำตอบ

คู่มือฉบับเต็ม

ส่วนนี้มี 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 / ฟอร์ม

ฟิลด์ชนิดจำเป็นการตรวจ⁠สอบ / คำอธิบาย
usernamestringไม่; อาจเป็น null
avatar_urlstringไม่; อาจเป็น null
balance_notify_enabledbooleanไม่; อาจเป็น null
balance_notify_thresholdnumberไม่; อาจเป็น 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_passwordstringใช่required
new_passwordstringใช่required,min=6
เทมเพลตเนื้อหาคำขอ
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER ระบุข้อมูลที่คุณต้องป้อนและชนิดข้อมูล ให้แทนค่าต่าง ๆ และคงไว้เฉพาะฟิลด์ที่ไม่จำเป็นแต่ต้องการใช้ อย่าส่งข้อความตัวแทนค่าแทนตัวเลข boolean ออบเจ็กต์ หรืออาร์เรย์

สคีมาคำขอ: 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

ข้อควรทราบ: ขีดจำกัดค่าใช้จ่ายของคีย์ (quota, quota_used) ส่งกลับในคำตอบเกี่ยวกับคีย์ ไม่ใช่ในโปรไฟล์ frozen_balance คือจำนวนเงินที่กันไว้ จึงไม่ใช่ยอดคงเหลือที่ใช้ได้

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 และรายละเอียดมาให้เรา เราจะช่วยตรวจ⁠สอบติดต่อฝ่ายสนับสนุน
เข้าสู่ระบบสมัครสมาชิกแผงควบคุม
ราคา