التوثيق
API لوحة الحساب

رموز شحن الرصيد

Markdown

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

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

يضم القسم طريقتين. افتح الطريقة لعرض شروط الوصول وحقول الطلب والرد.

الطريقة والمسارالوصفالوصول
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)"
  }
}

ملاحظات: تقتصر جميع البيانات الشخصية والكائنات على صاحب الهوية في JWT.

ملاحظات: تغيّر العملية الحالة أو تواصل مصادقة لمرة واحدة؛ يصف المثال العقد ولا يتم تنفيذه.

GET /api/v1/redeem/history — سجل استرداد الرموز

الوصول: توكن لوحة الحساب

GET/api/v1/redeem/history
قراءة؛ يُؤخذ ID من رد سابق لك
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

معاملات الاستعلام

الحقلالنوعمطلوبالتحقق / الوصف
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)"
  }
}

ملاحظات: تقتصر جميع البيانات الشخصية والكائنات على صاحب الهوية في JWT.

هل لديك أسئلة أخرى؟ أرسل Request ID ووصفاً للمشكلة وسنساعدك على فهمها.مراسلة الدعم