docs
Fiók-API

Feltöltőkódok

Markdown

Metódusok, kérésmezők és válaszok.

Teljes útmutató

Ebben a részben 2 metódus található. Nyissa meg a metódust a hozzáférési feltételek, a kérésmezők és a válasz megtekintéséhez.

Metódus és útvonalLeírásHozzáférés
POST /api/v1/redeemKód beváltásaFióktoken
GET /api/v1/redeem/historyBeváltási előzményekFióktoken
POST /api/v1/redeem — Kód beváltása

Hozzáférés: fióktoken

POST/api/v1/redeem

JSON- / űrlapmezők

Mező:TípusKötelezőEllenőrzés / leírás
codestringigenrequired
Kéréstörzs-sablon
{
  "code": "PLACEHOLDER_CODE (string)"
}

A PLACEHOLDER az Ön által megadandó értéket és annak típusát jelöli. Cserélje ki az értékeket, és csak a szükséges nem kötelező mezőket tartsa meg; karakterlánc-jelölők nem küldhetők számok, boolean értékek, objektumok vagy tömbök helyett.

A kérés sémája: RedeemRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: RedeemCode. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel
{
  "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)"
  }
}

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

GET /api/v1/redeem/history — Beváltási előzmények

Hozzáférés: fióktoken

GET/api/v1/redeem/history
Olvasás; az azonosító a korábbi válaszából származik
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

Query-paraméterek

Mező:TípusKötelezőEllenőrzés / leírás
pageintegernem; alapértelmezés: 1; positive integer
page_sizeintegernem; alapértelmezés: 20; positive; clamp to100

A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: RedeemCode. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel
{
  "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)"
  }
}

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Maradt kérdése? Küldje el a Request ID-t és a probléma leírását — segítünk tisztázni.Írjon a támogatásnak