Kódy pro doplnění zůstatku
MarkdownMetody, pole požadavků a odpovědi.
Úplný průvodce
V této sekci jsou 2 metody. Otevřete metodu a prohlédněte si podmínky přístupu, pole požadavku a odpověď.
| Metoda a cesta | Popis | Přístup |
|---|---|---|
POST /api/v1/redeem | Uplatnění kódu | Token uživatelského panelu |
GET /api/v1/redeem/history | Historie uplatnění | Token uživatelského panelu |
POST /api/v1/redeem – Uplatnění kódu
Přístup: token uživatelského panelu
/api/v1/redeemPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
code | string | ano | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechte pouze potřebná nepovinná pole; řetězcové zástupné značky se neodesílají místo čísel, hodnot typu boolean, objektů nebo polí.
Schéma požadavku: RedeemRequest
Odpověď
Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.
Datová schémata odpovědi: RedeemCode. Pole a typy najdete na stránkách „Datová schémata“.
{
"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)"
}
}Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.
Specifika: operace mění stav nebo pokračuje v jednorázové autorizaci; příklad popisuje kontrakt a neprovádí se.
GET /api/v1/redeem/history – Historie uplatnění
Přístup: token uživatelského panelu
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Parametry dotazu (query)
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
page | integer | ne | ; výchozí hodnota: 1; kladné celé číslo |
page_size | integer | ne | ; výchozí hodnota: 20; kladné číslo; hodnoty nad 100 se sníží na 100 |
Tělo požadavku není potřeba. Výše uvedené parametry předávejte v URL.
Odpověď
Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.
Datová schémata odpovědi: RedeemCode. Pole a typy najdete na stránkách „Datová schémata“.
{
"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)"
}
}Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.