פרופיל ואבטחה

מתודות, שדות בקשה ותשובות.

המדריך המלא

מספר המתודות בסעיף: 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)"
  }
}

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-JWT.

מאפיינים: הפעולה משנה מצב או ממשיכה תהליך אימות חד-פעמי; הדוגמה מתארת את החוזה ואינה מבוצעת.

מאפיינים: מגבלות ההוצאות של המפתחות (quota, quota_used) נכללות בתשובת המפתחות ולא בפרופיל. frozen_balance הוא סכום שנשמר כרזרבה, ואין לראות בו יתרה פנויה.

GET /api/v1/user/passkeys — רשימת passkey

גישה: טוקן של האזור האישי

GET/api/v1/user/passkeys

קריאה; המזהה נלקח מהתשובה הקודמת שקיבלתם

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

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-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"
  }
}

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-JWT.

מאפיינים: הפעולה משנה מצב או ממשיכה תהליך אימות חד-פעמי; הדוגמה מתארת את החוזה ואינה מבוצעת.

GET /api/v1/user/profile — פרופיל, יתרה וקישורים

גישה: טוקן של האזור האישי

GET/api/v1/user/profile

קריאה; המזהה נלקח מהתשובה הקודמת שקיבלתם

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

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-JWT.

GET /api/v1/user/totp/status — סטטוס 2FA (TOTP)

גישה: טוקן של האזור האישי

GET/api/v1/user/totp/status

קריאה; המזהה נלקח מהתשובה הקודמת שקיבלתם

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

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-JWT.

מאפיינים: secret ו-setup_token הם סודיים; האימות תלוי בהגדרות ה-TOTP ובמשתמש.

GET /api/v1/user/totp/verification-method — שיטת אימות TOTP

גישה: טוקן של האזור האישי

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

קריאה; המזהה נלקח מהתשובה הקודמת שקיבלתם

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

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-JWT.

מאפיינים: secret ו-setup_token הם סודיים; האימות תלוי בהגדרות ה-TOTP ובמשתמש.

TotpVerificationMethod

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

נשארו שאלות? שלחו Request ID ותיאור — נעזור לברר.פנייה לתמיכה