Source: https://ailoot.ai/docs/he/cabinet/auth/
Canonical: https://ailoot.ai/docs/he/cabinet/auth/
Language: he

[API של האזור האישי](https://ailoot.ai/docs/he/) 

# התחברות וסשנים

[Markdown](https://ailoot.ai/docs/he/cabinet/auth/index.md)

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

מספר המתודות בסעיף: 14. פתחו מתודה כדי לראות את תנאי הגישה, שדות הבקשה והתשובה.

| מתודה ונתיב | תיאור | גישה |
| --- | --- | --- |
| `POST /api/v1/auth/forgot-password` | בקשה לאיפוס סיסמה | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/login` | התחברות עם דוא"ל וסיסמה | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/login/2fa` | השלמת התחברות עם TOTP | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/logout` | התנתקות וביטול refresh token | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `GET /api/v1/auth/me` | המשתמש הנוכחי, היתרה והמגבלות | טוקן של האזור האישי |
| `POST /api/v1/auth/passkey/login/begin` | תחילת התחברות עם passkey | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/passkey/login/finish` | השלמת התחברות עם passkey | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/refresh` | רענון טוקנים | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/register` | הרשמה | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/reset-password` | איפוס סיסמה | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/revoke-all-sessions` | ביטול כל הסשנים | טוקן של האזור האישי |
| `POST /api/v1/auth/send-verify-code` | שליחת קוד אימות | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/validate-invitation-code` | בדיקת הזמנה | ללא התחברות; תנאים נוספים מפורטים במתודה |
| `POST /api/v1/auth/validate-promo-code` | בדיקת קוד קופון | ללא התחברות; תנאים נוספים מפורטים במתודה |

**POST /api/v1/auth/forgot-password** — בקשה לאיפוס סיסמה

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

מגבלת קצב: 5 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/forgot-password`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `email` | `string` | כן | required,email |
| `turnstile_token` | `string` | לא |  |

תבנית גוף הבקשה

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `ForgotPasswordRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `ForgotPasswordResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/login** — התחברות עם דוא"ל וסיסמה

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 20 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/login`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `email` | `string` | כן | required,email |
| `password` | `string` | כן | required |
| `turnstile_token` | `string` | לא |  |

תבנית גוף הבקשה

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `LoginRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `TotpLoginResponse`, `User`, `AuthResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

אם אפשריים כמה מבני תשובה, השדות שלהם מפורטים בסכמות נפרדות; אין לאחד אותם לאובייקט אחד.

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/login/2fa** — השלמת התחברות עם TOTP

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 20 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/login/2fa`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `temp_token` | `string` | כן | required |
| `totp_code` | `string` | כן | required,len=6 |

תבנית גוף הבקשה

```json
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `Login2FARequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `User`, `AuthResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

אם אפשריים כמה מבני תשובה, השדות שלהם מפורטים בסכמות נפרדות; אין לאחד אותם לאובייקט אחד.

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/logout** — התנתקות וביטול refresh token

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

POST`/api/v1/auth/logout`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `refresh_token` | `string` | לא | ; רשות: ביטול טוקן הרענון שצוין |

תבנית גוף הבקשה

```json
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `LogoutRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `LogoutResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**GET /api/v1/auth/me** — המשתמש הנוכחי, היתרה והמגבלות

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

GET`/api/v1/auth/me`

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

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"
```

אין צורך בגוף בקשה. העבירו את הפרמטרים המפורטים לעיל ב-URL.

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `User`, `UserProfileResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "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 הוא סכום שנשמר כרזרבה, ואין לראות בו יתרה פנויה.

**POST /api/v1/auth/passkey/login/begin** — תחילת התחברות עם passkey

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 20 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/passkey/login/begin`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `turnstile_token` | `string` | לא |  |

תבנית גוף הבקשה

```json
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `PasskeyBeginLoginRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `PasskeyOptionsResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}
```

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

מאפיינים: credential מתקבל מ-navigator.credentials ו-session\_token מ-begin. גוף Finish \<=65536 בתים; הרשמה ומחיקה דורשות סיסמה.

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/passkey/login/finish** — השלמת התחברות עם passkey

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 20 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/passkey/login/finish`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `session_token` | `string` | כן | required |
| `name` | `string` | לא |  |
| `credential` | `object` | כן | required |

תבנית גוף הבקשה

```json
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `PasskeyFinishRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `User`, `AuthResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

אם אפשריים כמה מבני תשובה, השדות שלהם מפורטים בסכמות נפרדות; אין לאחד אותם לאובייקט אחד.

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

מאפיינים: credential מתקבל מ-navigator.credentials ו-session\_token מ-begin. גוף Finish \<=65536 בתים; הרשמה ומחיקה דורשות סיסמה.

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/refresh** — רענון טוקנים

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 30 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/refresh`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `refresh_token` | `string` | כן | required |

תבנית גוף הבקשה

```json
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `RefreshTokenRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `RefreshTokenResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
    "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
    "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
    "token_type": "PLACEHOLDER_TOKEN_TYPE (string)"
  }
}
```

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/register** — הרשמה

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

מגבלת קצב: 5 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/register`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `email` | `string` | כן | required,email |
| `password` | `string` | כן | required,min=6 |
| `verify_code` | `string` | לא |  |
| `turnstile_token` | `string` | לא |  |
| `promo_code` | `string` | לא | ; קוד קופון להרשמה |
| `invitation_code` | `string` | לא | ; קוד הזמנה |

תבנית גוף הבקשה

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "verify_code": "PLACEHOLDER_VERIFY_CODE (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)",
  "promo_code": "PLACEHOLDER_PROMO_CODE (string)",
  "invitation_code": "PLACEHOLDER_INVITATION_CODE (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `RegisterRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `User`, `AuthResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

אם אפשריים כמה מבני תשובה, השדות שלהם מפורטים בסכמות נפרדות; אין לאחד אותם לאובייקט אחד.

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/reset-password** — איפוס סיסמה

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

מגבלת קצב: 10 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/reset-password`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `email` | `string` | כן | required,email |
| `token` | `string` | כן | required |
| `new_password` | `string` | כן | required,min=6 |

תבנית גוף הבקשה

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `ResetPasswordRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `ResetPasswordResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/revoke-all-sessions** — ביטול כל הסשנים

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

POST`/api/v1/auth/revoke-all-sessions`

אין צורך בגוף בקשה.

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `RevokeAllSessionsResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/send-verify-code** — שליחת קוד אימות

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

מגבלת קצב: 5 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/send-verify-code`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `email` | `string` | כן | required,email |
| `turnstile_token` | `string` | לא |  |

תבנית גוף הבקשה

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `SendVerifyCodeRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `SendVerifyCodeResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}
```

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

המתודה משנה נתונים. שליחה חוזרת בטוחה רק במתודות שבהן מצוין Idempotency-Key. אם התשובה אבדה, בדקו תחילה את התוצאה (למשל את רשימת המפתחות), ורק אז החליטו אם לשלוח את הבקשה שוב.

**POST /api/v1/auth/validate-invitation-code** — בדיקת הזמנה

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 10 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/validate-invitation-code`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `code` | `string` | כן | required |

תבנית גוף הבקשה

```json
{
  "code": "PLACEHOLDER_CODE (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `ValidateInvitationCodeRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `ValidateInvitationCodeResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}
```

מאפיינים: המתודה בודקת את ההזמנה ואינה מממשת את הקוד; הדוגמה מתארת את מפרט הממשק ואינה מבוצעת.

המתודה רק בודקת את קוד ההזמנה ואינה מממשת אותו. ניתן לחזור על הבדיקה בכפוף למגבלת קצב הבקשות; התוצאה משקפת את מצב הקוד בזמן הבקשה.

**POST /api/v1/auth/validate-promo-code** — בדיקת קוד קופון

גישה: ללא התחברות; תנאים נוספים מפורטים במתודה

זמינות הפונקציה ותנאי גישה נוספים נבדקים בזמן ביצוע הבקשה.

מגבלת קצב: 10 בקשות ב-60 שניות מאותה כתובת.

POST`/api/v1/auth/validate-promo-code`

## שדות JSON / טופס

| השדה | טיפוס | חובה | בדיקה / תיאור |
| --- | --- | --- | --- |
| `code` | `string` | כן | required |

תבנית גוף הבקשה

```json
{
  "code": "PLACEHOLDER_CODE (string)"
}
```

PLACEHOLDER מציין את הקלט שלכם ואת הטיפוס שלו. החליפו את הערכים והשאירו רק את שדות הרשות הנדרשים; אין לשלוח סמני מחרוזת במקום מספרים, boolean, אובייקטים או מערכים.

סכמת הבקשה: `ValidatePromoCodeRequest`

## תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: `ValidatePromoCodeResponse`. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

סכמת התשובה, הערכים להמחשה

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "bonus_amount": "PLACEHOLDER_BONUS_AMOUNT (number)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)",
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

מאפיינים: המתודה בודקת את קוד המבצע ואינה מזכה בבונוס; הדוגמה מתארת את מפרט הממשק ואינה מבוצעת.

המתודה רק בודקת את קוד המבצע ואינה מחילה אותו על החשבון. ניתן לחזור על הבדיקה בכפוף למגבלת קצב הבקשות; התוצאה משקפת את מצב הקוד בזמן הבקשה.

## התחברות וסשנים · 2FA

`POST /api/v1/auth/login` → `data`

- `data.requires_2fa === true` → [TotpLoginResponse](https://ailoot.ai/docs/he/cabinet/schemas-1/#totploginresponse) → `data.temp_token` → `POST /api/v1/auth/login/2fa` · `{"temp_token": "…", "totp_code": "…"}` → `data.access_token`
- `data.access_token` → [AuthResponse](https://ailoot.ai/docs/he/cabinet/schemas-1/#authresponse) → `Authorization: Bearer $TOKEN`

`totp_code`: `string`, `len = 6`. `temp_token ≠ access_token`. [User](https://ailoot.ai/docs/he/cabinet/schemas-1/#user)

נשארו שאלות? שלחו Request ID ותיאור — נעזור לברר.[פנייה לתמיכה](mailto:support@ailoot.ai)

## Ailoot · החברה ופורטפוליו הפרויקטים שלה





Ailoot נשענת על ניסיון תפעולי מצטבר, בסיס לקוחות רחב, שירות יציב ובקרה שוטפת של KPI.





החברה ופורטפוליו הפרויקטים שלה: מיליוני לקוחות; מכירות בהיקף של מיליארדים מדי חודש.





Ailoot משתמשת בניסיון התפעולי הזה כדי לספק גישת API ליכולות AI במוצרי לקוחות, בסוכנים, באפליקציות ובאוטומציות.