dokumentasi
API dasbor

Kode isi ulang

Markdown

Metode, kolom permintaan, dan respons.

Panduan lengkap

Bagian ini berisi 2 metode. Buka metode untuk melihat ketentuan akses, kolom permintaan, dan respons.

Metode dan jalurDeskripsiAkses
POST /api/v1/redeemPenukaran kodeToken dasbor
GET /api/v1/redeem/historyRiwayat penukaranToken dasbor
POST /api/v1/redeem — Penukaran kode

Akses: Token dasbor

POST/api/v1/redeem

Kolom JSON / formulir

KolomJenisWajibValidasi / deskripsi
codestringyarequired
Templat isi permintaan
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER mewakili input Anda dan tipenya. Ganti nilai-nilainya dan sisakan hanya kolom opsional yang diperlukan; jangan kirim penanda string sebagai pengganti angka, boolean, objek, atau array.

Skema permintaan: RedeemRequest

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema data respons: RedeemCode. Kolom dan tipe dijelaskan di halaman “Skema data”.

Skema respons, nilai hanya contoh
{
  "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)"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: Operasi mengubah keadaan atau melanjutkan autentikasi sekali pakai; contoh menjelaskan kontrak dan tidak dijalankan.

GET /api/v1/redeem/history — Riwayat penukaran

Akses: Token dasbor

GET/api/v1/redeem/history
Pembacaan; ID diambil dari respons Anda sebelumnya
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

Parameter query

KolomJenisWajibValidasi / deskripsi
pageintegertidak; default: 1; positive integer
page_sizeintegertidak; default: 20; positive; clamp to100

Isi permintaan tidak diperlukan. Kirim parameter di atas dalam URL.

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema data respons: RedeemCode. Kolom dan tipe dijelaskan di halaman “Skema data”.

Skema respons, nilai hanya contoh
{
  "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)"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Masih ada pertanyaan? Kirim Request ID dan penjelasannya — kami akan membantu.Hubungi dukungan