Kod tambah nilai
MarkdownKaedah, medan permintaan dan respons.
Panduan lengkap
Bahagian ini mengandungi 2 kaedah. Buka kaedah untuk melihat syarat akses, medan permintaan dan respons.
| Kaedah dan laluan | Penerangan | Akses |
|---|---|---|
POST /api/v1/redeem | Penebusan kod | Token panel pengguna |
GET /api/v1/redeem/history | Sejarah penebusan | Token panel pengguna |
POST /api/v1/redeem — Penebusan kod
Akses: Token panel pengguna
/api/v1/redeemMedan JSON / borang
| Medan | Jenis | Wajib | Pengesahan / penerangan |
|---|---|---|---|
code | string | ya | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER mewakili input anda dan jenisnya. Gantikan nilai dan kekalkan hanya medan pilihan yang diperlukan; penanda rentetan tidak boleh dihantar sebagai ganti nombor, boolean, objek atau tatasusunan.
Skema permintaan: RedeemRequest
Respons
Respons JSON mengandungi code, message dan data. Kandungan data diterangkan dalam skema di bawah.
Skema data respons: RedeemCode. Medan dan jenisnya terdapat pada halaman “Skema data”.
{
"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)"
}
}Nota khusus: Semua data peribadi dan objek dihadkan kepada subjek JWT.
Nota khusus: Operasi mengubah keadaan atau meneruskan pengesahan sekali guna; contoh ini menerangkan kontrak dan tidak dijalankan.
GET /api/v1/redeem/history — Sejarah penebusan
Akses: Token panel pengguna
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Parameter pertanyaan
| Medan | Jenis | Wajib | Pengesahan / penerangan |
|---|---|---|---|
page | integer | tidak | ; nilai lalai: 1; positive integer |
page_size | integer | tidak | ; nilai lalai: 20; positive; clamp to100 |
Badan permintaan tidak diperlukan. Hantar parameter yang dinyatakan di atas dalam URL.
Respons
Respons JSON mengandungi code, message dan data. Kandungan data diterangkan dalam skema di bawah.
Skema data respons: RedeemCode. Medan dan jenisnya terdapat pada halaman “Skema data”.
{
"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)"
}
}Nota khusus: Semua data peribadi dan objek dihadkan kepada subjek JWT.