Kode za dodajanje sredstev

Metode, polja zahtev in odgovori.

Celoten vodnik

V razdelku sta 2 metodi. Odprite metodo, da si ogledate pogoje dostopa, polja zahteve in odgovor.

Metoda in pot	Opis	Dostop
`POST /api/v1/redeem`	Unovčenje kode	Žeton nadzorne plošče
`GET /api/v1/redeem/history`	Zgodovina unovčenj	Žeton nadzorne plošče

POST /api/v1/redeem – Unovčenje kode

Dostop: Žeton nadzorne plošče

POST/api/v1/redeem

Polja JSON / obrazca

Polje	Vrsta	Obvezno	Preverjanje / opis
`code`	`string`	da	required

Predloga telesa zahteve

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

PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.

Shema zahteve: RedeemRequest

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Podatkovne sheme odgovora: RedeemCode. Polja in vrste so na straneh »Podatkovne sheme«.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.

GET /api/v1/redeem/history – Zgodovina unovčenj

Dostop: Žeton nadzorne plošče

GET/api/v1/redeem/history

Branje; ID je iz vašega prejšnjega odgovora

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

Parametri poizvedbe

Polje	Vrsta	Obvezno	Preverjanje / opis
`page`	`integer`	ne	; privzeto: 1; pozitivno celo število
`page_size`	`integer`	ne	; privzeto: 20; pozitivno; vrednost se omeji na 100

Telo zahteve ni potrebno. Zgoraj navedene parametre pošljite v URL.

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Podatkovne sheme odgovora: RedeemCode. Polja in vrste so na straneh »Podatkovne sheme«.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Imate še vprašanja? Pošljite Request ID in opis – pomagali vam bomo razjasniti težavo.Pišite podpori