Indbetalingskoder

Metoder, anmodningsfelter og svar.

Komplet guide

Afsnittet indeholder 2 metoder. Åbn en metode for at se adgangsbetingelser, anmodningsfelter og svar.

Metode og sti	Beskrivelse	Adgang
`POST /api/v1/redeem`	Indløsning af kode	Kontrolpanelets token
`GET /api/v1/redeem/history`	Indløsningshistorik	Kontrolpanelets token

POST /api/v1/redeem — Indløsning af kode

Adgang: kontrolpanelets token

POST/api/v1/redeem

JSON- / formularfelter

Feltet	Type	Obligatorisk	Validering / beskrivelse
`code`	`string`	ja	required

Skabelon til anmodningens indhold

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

PLACEHOLDER angiver dit input og dets type. Erstat værdierne, og behold kun de valgfrie felter, du har brug for; strengmarkører sendes ikke i stedet for tal, boolean, objekter eller lister.

Anmodningsskema: RedeemRequest

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarenes dataskemaer: RedeemCode. Felter og typer findes på siderne »Dataskemaer«.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: Handlingen ændrer tilstanden eller fortsætter en engangsautorisation; eksemplet beskriver kontrakten og udføres ikke.

GET /api/v1/redeem/history — Indløsningshistorik

Adgang: kontrolpanelets token

GET/api/v1/redeem/history

Læsning; ID hentes fra dit tidligere svar

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

Query-parametre

Feltet	Type	Obligatorisk	Validering / beskrivelse
`page`	`integer`	nej	; som standard: 1; positivt heltal
`page_size`	`integer`	nej	; som standard: 20; positiv værdi; begrænses til højst 100

Anmodningens indhold er ikke nødvendigt. Send de ovenstående parametre i URL'en.

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarenes dataskemaer: RedeemCode. Felter og typer findes på siderne »Dataskemaer«.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Har du stadig spørgsmål? Send Request ID og en beskrivelse — så hjælper vi med at finde ud af det.Kontakt support