Opwaardeercodes

Methoden, verzoekvelden en antwoorden.

Volledige gids

Dit onderdeel bevat 2 methoden. Open een methode om de toegangsvoorwaarden, verzoekvelden en het antwoord te bekijken.

Methode en pad	Beschrijving	Toegang
`POST /api/v1/redeem`	Code inwisselen	Dashboardtoken
`GET /api/v1/redeem/history`	Inwisselgeschiedenis	Dashboardtoken

POST /api/v1/redeem — Code inwisselen

Toegang: dashboardtoken

POST/api/v1/redeem

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`code`	`string`	ja	required

Sjabloon voor de verzoekbody

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

PLACEHOLDER geeft jouw invoer en het bijbehorende type aan. Vervang de waarden en behoud alleen de benodigde optionele velden; verstuur stringmarkeringen niet in plaats van getallen, boolean, objecten of arrays.

Verzoekschema: RedeemRequest

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Gegevensschema’s van het antwoord: RedeemCode. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

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

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: de bewerking wijzigt de toestand of zet een eenmalige autorisatie voort; het voorbeeld beschrijft het contract en wordt niet uitgevoerd.

GET /api/v1/redeem/history — Inwisselgeschiedenis

Toegang: dashboardtoken

GET/api/v1/redeem/history

Leesbewerking; de ID komt uit je vorige antwoord

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

Queryparameters

Het veld	Type	Verplicht	Validatie / beschrijving
`page`	`integer`	nee	; standaard: 1; positief geheel getal
`page_size`	`integer`	nee	; standaard: 20; positief; begrensd tot 100

Er is geen verzoekbody nodig. Geef de hierboven genoemde parameters mee in de URL.