Påfyllingskoder

Metoder, forespørselsfelter og svar.

Fullstendig guide

Seksjonen har 2 metoder. Åpne en metode for å se tilgangsvilkår, forespørselsfelter og svar.

Metode og endepunkt	Beskrivelse	Tilgang
`POST /api/v1/redeem`	Løs inn kode	Kontrollpaneltoken
`GET /api/v1/redeem/history`	Innløsningshistorikk	Kontrollpaneltoken

POST /api/v1/redeem — Løs inn kode

Tilgang: kontrollpaneltoken

POST/api/v1/redeem

JSON- / skjemafelter

Feltet	Type	Påkrevd	Validering / beskrivelse
`code`	`string`	ja	required

Mal for forespørselskropp

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

PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.

Forespørselsskjema: RedeemRequest

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: RedeemCode. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.

GET /api/v1/redeem/history — Innløsningshistorikk

Tilgang: kontrollpaneltoken

GET/api/v1/redeem/history

Lesing; ID hentes fra ditt forrige svar

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

Query-parametere

Feltet	Type	Påkrevd	Validering / beskrivelse
`page`	`integer`	nei	; standard: 1; positivt heltall
`page_size`	`integer`	nei	; standard: 20; positiv; avgrenses til 100

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: RedeemCode. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Flere spørsmål? Send Request ID og en beskrivelse, så hjelper vi deg.Kontakt brukerstøtte