Papildymo kodai

Metodai, užklausų laukai ir atsakymai.

Visas vadovas

Skiltyje yra 2 metodai. Atverkite metodą, kad peržiūrėtumėte prieigos sąlygas, užklausos laukus ir atsakymą.

Metodas ir kelias	Aprašymas	Prieiga
`POST /api/v1/redeem`	Kodo panaudojimas	Paskyros žetonas
`GET /api/v1/redeem/history`	Kodų panaudojimo istorija	Paskyros žetonas

POST /api/v1/redeem — Kodo panaudojimas

Prieiga: paskyros žetonas

POST/api/v1/redeem

JSON / formos laukai

Laukas	Tipas	Privaloma	Patikra / aprašymas
`code`	`string`	taip	required

Užklausos turinio šablonas

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

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: RedeemRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: RedeemCode. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

GET /api/v1/redeem/history — Kodų panaudojimo istorija

Prieiga: paskyros žetonas

GET/api/v1/redeem/history

Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo

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

Užklausos eilutės parametrai

Laukas	Tipas	Privaloma	Patikra / aprašymas
`page`	`integer`	ne	; numatytoji reikšmė: 1; positive integer
`page_size`	`integer`	ne	; numatytoji reikšmė: 20; positive; clamp to100

Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: RedeemCode. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Liko klausimų? Atsiųskite Request ID ir aprašymą — padėsime išsiaiškinti.Rašyti pagalbos tarnybai