Saldon latauskoodit

Metodit, pyyntöjen kentät ja vastaukset.

Koko opas

Osiossa on 2 metodia. Avaa metodi nähdäksesi käyttöoikeusehdot, pyynnön kentät ja vastauksen.

Metodi ja polku	Kuvaus	Käyttöoikeus
`POST /api/v1/redeem`	Koodin lunastaminen	Hallintapaneelin token
`GET /api/v1/redeem/history`	Lunastushistoria	Hallintapaneelin token

POST /api/v1/redeem — Koodin lunastaminen

Käyttöoikeus: hallintapaneelin token

POST/api/v1/redeem

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`code`	`string`	kyllä	required

Pyynnön rungon mallipohja

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

PLACEHOLDER merkitsee omaa syötettäsi ja sen tyyppiä. Korvaa arvot ja säilytä vain tarvitsemasi valinnaiset kentät; merkkijonomerkkejä ei lähetetä lukujen, boolean-arvojen, objektien tai taulukoiden sijaan.

Pyynnön skeema: RedeemRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: RedeemCode. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin.

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

GET /api/v1/redeem/history — Lunastushistoria

Käyttöoikeus: hallintapaneelin token

GET/api/v1/redeem/history

Lukutoiminto; ID otetaan aiemmasta vastauksestasi

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

Kyselyparametrit

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`page`	`integer`	ei	; oletus: 1; positiivinen kokonaisluku
`page_size`	`integer`	ei	; oletus: 20; positiivinen arvo; rajoitetaan enintään 100:aan

Pyynnön runkoa ei tarvita. Lähetä yllä luetellut parametrit URLissa.

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: RedeemCode. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin.

Onko vielä kysyttävää? Lähetä Request ID ja kuvaus — autamme selvittämään asian.Ota yhteyttä tukeen