Codici di ricarica
MarkdownMetodi, campi delle richieste e risposte.
Guida completa
La sezione contiene 2 metodi. Apri un metodo per vedere condizioni di accesso, campi della richiesta e risposta.
| Metodo e percorso | Descrizione | Accesso |
|---|---|---|
POST /api/v1/redeem | Riscatto del codice | Token dell’area personale |
GET /api/v1/redeem/history | Cronologia dei riscatti | Token dell’area personale |
POST /api/v1/redeem — Riscatto del codice
Accesso: token dell’area personale
/api/v1/redeemCampi JSON / modulo
| Il campo | Tipo | Obbligatorio | Verifica / descrizione |
|---|---|---|---|
code | string | sì | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER indica il tuo input e il suo tipo. Sostituisci i valori e mantieni solo i campi facoltativi necessari; i segnaposto stringa non vanno inviati al posto di numeri, boolean, oggetti o array.
Schema della richiesta: RedeemRequest
Risposta
La risposta JSON contiene code, message e data. Il contenuto di data è descritto negli schemi sotto.
Schemi dei dati della risposta: RedeemCode. Campi e tipi sono nelle pagine «Schemi dei dati».
{
"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)"
}
}Particolarità: Tutti i dati personali e gli oggetti sono limitati al soggetto JWT.
Particolarità: L’operazione modifica lo stato o prosegue un’autorizzazione monouso; l’esempio descrive il contratto e non viene eseguito.
GET /api/v1/redeem/history — Cronologia dei riscatti
Accesso: token dell’area personale
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Parametri query
| Il campo | Tipo | Obbligatorio | Verifica / descrizione |
|---|---|---|---|
page | integer | no | ; predefinito: 1; intero positivo |
page_size | integer | no | ; predefinito: 20; positivo; limitato a 100 |
Il corpo della richiesta non è necessario. Passa i parametri indicati sopra nell’URL.
Risposta
La risposta JSON contiene code, message e data. Il contenuto di data è descritto negli schemi sotto.
Schemi dei dati della risposta: RedeemCode. Campi e tipi sono nelle pagine «Schemi dei dati».
{
"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)"
}
}Particolarità: Tutti i dati personali e gli oggetti sono limitati al soggetto JWT.