Aufladecodes
MarkdownMethoden, Request-Felder und Antworten.
Vollständiger Leitfaden
Dieser Abschnitt enthält 2 Methoden. Öffnen Sie eine Methode, um Zugriffsbedingungen, Request-Felder und Antwort einzusehen.
| Methode und Pfad | Beschreibung | Zugriff |
|---|---|---|
POST /api/v1/redeem | Code einlösen | Token des Kundenbereichs |
GET /api/v1/redeem/history | Einlösungsverlauf | Token des Kundenbereichs |
POST /api/v1/redeem — Code einlösen
Zugriff: Token des Kundenbereichs
/api/v1/redeemJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Validierung / Beschreibung |
|---|---|---|---|
code | string | ja | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER steht für Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder; String-Platzhalter dürfen nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet werden.
Request-Schema: RedeemRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.
Datenschemata der Antwort: RedeemCode. Felder und Typen finden Sie auf den Seiten „Datenschemata“.
{
"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)"
}
}Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.
Besonderheiten: Der Vorgang ändert den Zustand oder setzt eine einmalige Authentifizierung fort; das Beispiel beschreibt den Vertrag und wird nicht ausgeführt.
GET /api/v1/redeem/history — Einlösungsverlauf
Zugriff: Token des Kundenbereichs
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Query-Parameter
| Das Feld | Typ | Erforderlich | Validierung / Beschreibung |
|---|---|---|---|
page | integer | nein | ; standardmäßig: 1; positive integer |
page_size | integer | nein | ; standardmäßig: 20; positive; clamp to100 |
Ein Request-Body ist nicht erforderlich. Übergeben Sie die oben genannten Parameter in der URL.
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.
Datenschemata der Antwort: RedeemCode. Felder und Typen finden Sie auf den Seiten „Datenschemata“.
{
"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)"
}
}Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.