Kódy na dobitie

Metódy, polia požiadaviek a odpovede.

Úplný sprievodca

Sekcia obsahuje 2 metódy. Otvorte metódu a pozrite si podmienky prístupu, polia požiadavky a odpoveď.

Metóda a cesta	Opis	Prístup
`POST /api/v1/redeem`	Uplatnenie kódu	Token používateľského účtu
`GET /api/v1/redeem/history`	História uplatnených kódov	Token používateľského účtu

POST /api/v1/redeem – Uplatnenie kódu

Prístup: token používateľského účtu

POST/api/v1/redeem

Polia JSON / formulára

Pole	Typ	Povinné	Kontrola / opis
`code`	`string`	áno	required

Šablóna tela požiadavky

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

PLACEHOLDER označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechajte iba potrebné voliteľné polia; reťazcové zástupné hodnoty sa neodosielajú namiesto čísel, hodnôt boolean, objektov alebo polí.

Schéma požiadavky: RedeemRequest

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Dátové schémy odpovede: RedeemCode. Polia a typy nájdete na stránkach „Dátové schémy“.

Schéma odpovede, ilustračné hodnoty

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

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: operácia mení stav alebo pokračuje v jednorazovej autorizácii; príklad opisuje kontrakt a nevykonáva sa.

GET /api/v1/redeem/history – História uplatnených kódov

Prístup: token používateľského účtu

GET/api/v1/redeem/history

Čítanie; ID sa preberá z vašej predchádzajúcej odpovede

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

Parametre query

Pole	Typ	Povinné	Kontrola / opis
`page`	`integer`	nie	; predvolene: 1; positive integer
`page_size`	`integer`	nie	; predvolene: 20; positive; clamp to100

Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL.

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Dátové schémy odpovede: RedeemCode. Polia a typy nájdete na stránkach „Dátové schémy“.

Schéma odpovede, ilustračné hodnoty

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

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Máte ďalšie otázky? Pošlite Request ID a opis problému – pomôžeme vám ho vyriešiť.Napísať podpore