Κωδικοί ανανέωσης υπολοίπου
MarkdownΜέθοδοι, πεδία αιτημάτων και απαντήσεις.
Πλήρης οδηγός
Η ενότητα περιλαμβάνει 2 μεθόδους. Ανοίξτε τη μέθοδο για να δείτε τους όρους πρόσβασης, τα πεδία αιτήματος και την απάντηση.
| Μέθοδος και διαδρομή | Περιγραφή | Πρόσβαση |
|---|---|---|
POST /api/v1/redeem | Εξαργύρωση κωδικού | Token πίνακα ελέγχου |
GET /api/v1/redeem/history | Ιστορικό εξαργυρώσεων | Token πίνακα ελέγχου |
POST /api/v1/redeem — Εξαργύρωση κωδικού
Πρόσβαση: Token πίνακα ελέγχου
/api/v1/redeemΠεδία JSON / φόρμας
| Το πεδίο | Τύπος | Υποχρεωτικό | Έλεγχος / περιγραφή |
|---|---|---|---|
code | string | ναι | required |
{
"code": "PLACEHOLDER_CODE (string)"
}Το PLACEHOLDER υποδηλώνει τη δική σας είσοδο και τον τύπο της. Αντικαταστήστε τις τιμές και κρατήστε μόνο τα προαιρετικά πεδία που χρειάζονται· οι συμβολοσειρές-δείκτες δεν αποστέλλονται αντί για αριθμούς, boolean, αντικείμενα ή πίνακες.
Σχήμα αιτήματος: RedeemRequest
Απάντηση
Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.
Σχήματα δεδομένων απάντησης: RedeemCode. Τα πεδία και οι τύποι βρίσκονται στις σελίδες «Σχήματα δεδομένων».
{
"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)"
}
}Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.
Ιδιαιτερότητες: Η λειτουργία αλλάζει την κατάσταση ή συνεχίζει διαδικασία εξουσιοδότησης μίας χρήσης· το παράδειγμα περιγράφει τη σύμβαση και δεν εκτελείται.
GET /api/v1/redeem/history — Ιστορικό εξαργυρώσεων
Πρόσβαση: Token πίνακα ελέγχου
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Παράμετροι ερωτήματος
| Το πεδίο | Τύπος | Υποχρεωτικό | Έλεγχος / περιγραφή |
|---|---|---|---|
page | integer | όχι | ; από προεπιλογή: 1; θετικός ακέραιος |
page_size | integer | όχι | ; από προεπιλογή: 20; θετικό· ανώτατο όριο 100 |
Δεν απαιτείται σώμα αιτήματος. Στείλτε τις παραπάνω παραμέτρους στο URL.
Απάντηση
Η απάντηση JSON περιέχει code, message και data. Το περιεχόμενο του data περιγράφεται στα σχήματα παρακάτω.
Σχήματα δεδομένων απάντησης: RedeemCode. Τα πεδία και οι τύποι βρίσκονται στις σελίδες «Σχήματα δεδομένων».
{
"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)"
}
}Ιδιαιτερότητες: Όλα τα προσωπικά δεδομένα και αντικείμενα περιορίζονται στο υποκείμενο του JWT.