Påfyllningskoder
MarkdownMetoder, anropsfält och svar.
Fullständig guide
Avsnittet innehåller 2 metoder. Öppna en metod för att se åtkomstvillkor, anropsfält och svar.
| Metod och sökväg | Beskrivning | Åtkomst |
|---|---|---|
POST /api/v1/redeem | Lös in kod | Kontrollpaneltoken |
GET /api/v1/redeem/history | Inlösningshistorik | Kontrollpaneltoken |
POST /api/v1/redeem — Lös in kod
Åtkomst: kontrollpaneltoken
/api/v1/redeemJSON-/formulärfält
| Fältet | Typ | Obligatoriskt | Validering / beskrivning |
|---|---|---|---|
code | string | ja | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER anger dina indata och deras typ. Ersätt värdena och behåll endast de valfria fält du behöver; strängmarkörer ska inte skickas i stället för tal, boolean, objekt eller arrayer.
Anropsschema: RedeemRequest
Svar
JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.
Datascheman för svaret: RedeemCode. Fält och typer finns på sidorna ”Datascheman”.
{
"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)"
}
}Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.
Observera: Operationen ändrar tillstånd eller fortsätter en engångsautentisering; exemplet beskriver kontraktet och körs inte.
GET /api/v1/redeem/history — Inlösningshistorik
Åtkomst: kontrollpaneltoken
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Query-parametrar
| Fältet | Typ | Obligatoriskt | Validering / beskrivning |
|---|---|---|---|
page | integer | nej | ; standard: 1; positivt heltal |
page_size | integer | nej | ; standard: 20; positivt värde; begränsas till 100 |
Ingen anropskropp krävs. Skicka parametrarna ovan i URL:en.
Svar
JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.
Datascheman för svaret: RedeemCode. Fält och typer finns på sidorna ”Datascheman”.
{
"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)"
}
}Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.