תיעוד
API של האזור האישי

קודים להוספת כסף ליתרה

Markdown

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

המדריך המלא

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

מתודה ונתיבתיאורגישה
POST /api/v1/redeemמימוש קודטוקן של האזור האישי
GET /api/v1/redeem/historyהיסטוריית המימושיםטוקן של האזור האישי
POST /api/v1/redeem — מימוש קוד

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

POST/api/v1/redeem

שדות JSON / טופס

השדהטיפוסחובהבדיקה / תיאור
codestringכןrequired
תבנית גוף הבקשה
{
  "code": "PLACEHOLDER_CODE (string)"
}

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

סכמת הבקשה: RedeemRequest

תשובה

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

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

סכמת התשובה, הערכים להמחשה
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "code": "PLACEHOLDER_CODE (string)",
    "type": "PLACEHOLDER_TYPE (string)",
    "value": "PLACEHOLDER_VALUE (number)",
    "status": "PLACEHOLDER_STATUS (string)",
    "used_by": "PLACEHOLDER_USED_BY (integer)",
    "used_at": "PLACEHOLDER_USED_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
    "notes": "PLACEHOLDER_NOTES (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}

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

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

GET /api/v1/redeem/history — היסטוריית המימושים

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

GET/api/v1/redeem/history
קריאה; המזהה נלקח מהתשובה הקודמת שקיבלתם
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

פרמטרי Query

השדהטיפוסחובהבדיקה / תיאור
pageintegerלא; ברירת המחדל: 1; positive integer
page_sizeintegerלא; ברירת המחדל: 20; positive; clamp to100

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

תשובה

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

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

סכמת התשובה, הערכים להמחשה
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "PLACEHOLDER_ID (integer)",
        "code": "PLACEHOLDER_CODE (string)",
        "type": "PLACEHOLDER_TYPE (string)",
        "value": "PLACEHOLDER_VALUE (number)",
        "status": "PLACEHOLDER_STATUS (string)",
        "used_by": "PLACEHOLDER_USED_BY (integer)",
        "used_at": "PLACEHOLDER_USED_AT (string)",
        "created_at": "PLACEHOLDER_CREATED_AT (string)",
        "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
        "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
        "notes": "PLACEHOLDER_NOTES (string)",
        "user": "PLACEHOLDER_USER (object)"
      }
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}

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

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