رموز شحن الرصيد
Markdownالطرق وحقول الطلبات والردود.
الدليل الكامل
يضم القسم طريقتين. افتح الطريقة لعرض شروط الوصول وحقول الطلب والرد.
| الطريقة والمسار | الوصف | الوصول |
|---|---|---|
POST /api/v1/redeem | استرداد الرمز | توكن لوحة الحساب |
GET /api/v1/redeem/history | سجل استرداد الرموز | توكن لوحة الحساب |
POST /api/v1/redeem — استرداد الرمز
الوصول: توكن لوحة الحساب
/api/v1/redeemحقول JSON / النموذج
| الحقل | النوع | مطلوب | التحقق / الوصف |
|---|---|---|---|
code | string | نعم | 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 — سجل استرداد الرموز
الوصول: توكن لوحة الحساب
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"معاملات الاستعلام
| الحقل | النوع | مطلوب | التحقق / الوصف |
|---|---|---|---|
page | integer | لا | ؛ القيمة الافتراضية: 1; positive integer |
page_size | integer | لا | ؛ القيمة الافتراضية: 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.