Толықтыру кодтары
MarkdownӘдістер, сұрау өрістері және жауаптар.
Толық нұсқаулық
Бөлімде 2 әдіс бар. Қол жеткізу шарттарын, сұрау өрістерін және жауапты көру үшін әдісті ашыңыз.
| Әдіс және жол | Сипаттамасы | Қол жеткізу |
|---|---|---|
POST /api/v1/redeem | Кодты пайдалану | Жеке кабинет токені |
GET /api/v1/redeem/history | Пайдаланылған кодтар тарихы | Жеке кабинет токені |
POST /api/v1/redeem — Кодты пайдалану
Қол жеткізу: жеке кабинет токені
/api/v1/redeemJSON / форма өрістері
| Өріс | Түрі | Міндетті | Тексеру / сипаттама |
|---|---|---|---|
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"Query параметрлері
| Өріс | Түрі | Міндетті | Тексеру / сипаттама |
|---|---|---|---|
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 субъектісімен шектелген.