Balans to‘ldirish kodlari

Metodlar, so‘rov maydonlari va javoblar.

To‘liq qo‘llanma

Bo‘limda 2 ta metod bor. Kirish shartlari, so‘rov maydonlari va javobni ko‘rish uchun metodni oching.

Metod va yo‘l	Tavsif	Kirish huquqi
`POST /api/v1/redeem`	Kodni ishlatish	Boshqaruv paneli tokeni
`GET /api/v1/redeem/history`	Kodlarni ishlatish tarixi	Boshqaruv paneli tokeni

POST /api/v1/redeem — Kodni ishlatish

Kirish: Boshqaruv paneli tokeni

POST/api/v1/redeem

JSON / forma maydonlari

Maydon:	Tur	Majburiy	Tekshiruv / tavsif
`code`	`string`	ha	required

So‘rov tanasi shabloni

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

PLACEHOLDER siz kiritadigan qiymat va uning turini bildiradi. Qiymatlarni almashtiring va faqat kerakli ixtiyoriy maydonlarni qoldiring; sonlar, boolean, obyektlar yoki massivlar o‘rniga matnli belgilar yuborilmaydi.

So‘rov sxemasi: RedeemRequest

Javob

JSON javobi code, message va data maydonlarini o‘z ichiga oladi. data mazmuni quyidagi sxemalarda tasvirlangan.

Javob ma’lumotlari sxemalari: RedeemCode. Maydonlar va turlar “Ma’lumotlar sxemalari” sahifalarida.

Javob sxemasi, qiymatlar shartli

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

Xususiyatlar: Barcha shaxsiy ma’lumotlar va obyektlar JWT subyekti bilan cheklangan.

Xususiyatlar: operatsiya holatni o‘zgartiradi yoki bir martalik avtorizatsiyani davom ettiradi; misol API interfeysining shartlarini tavsiflaydi va bajarilmaydi.

GET /api/v1/redeem/history — Kodlarni ishlatish tarixi

Kirish: Boshqaruv paneli tokeni

GET/api/v1/redeem/history

O‘qish; ID oldingi javobingizdan olinadi

curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

Query parametrlari

Maydon:	Tur	Majburiy	Tekshiruv / tavsif
`page`	`integer`	yo‘q	; standart qiymat: 1; positive integer
`page_size`	`integer`	yo‘q	; standart qiymat: 20; positive; clamp to100

So‘rov tanasi talab qilinmaydi. Yuqoridagi parametrlarni URL orqali uzating.