dokumentacja
API panelu użytkownika

Kody doładowania

Markdown

Metody, pola żądań i odpowiedzi.

Pełny przewodnik

W tej sekcji są 2 metody. Otwórz metodę, aby zobaczyć warunki dostępu, pola żądania i odpowiedź.

Metoda i ścieżkaOpisDostęp
POST /api/v1/redeemRealizacja koduToken panelu użytkownika
GET /api/v1/redeem/historyHistoria realizacjiToken panelu użytkownika
POST /api/v1/redeem — Realizacja kodu

Dostęp: Token panelu użytkownika

POST/api/v1/redeem

Pola JSON / formularza

PoleTypWymaganeWalidacja / opis
codestringtakrequired
Szablon treści żądania
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.

Schemat żądania: RedeemRequest

Odpowiedź

Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.

Schematy danych odpowiedzi: RedeemCode. Pola i typy — na stronach „Schematy danych”.

Schemat odpowiedzi, wartości przykładowe
{
  "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)"
  }
}

Cechy szczególne: Wszystkie dane osobowe i obiekty są ograniczone do podmiotu JWT.

Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.

GET /api/v1/redeem/history — Historia realizacji

Dostęp: Token panelu użytkownika

GET/api/v1/redeem/history
Odczyt; ID pochodzi z Twojej poprzedniej odpowiedzi
curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

Parametry zapytania

PoleTypWymaganeWalidacja / opis
pageintegernie; domyślnie: 1; positive integer
page_sizeintegernie; domyślnie: 20; positive; clamp to100

Treść żądania nie jest wymagana. Przekaż wskazane powyżej parametry w URL.

Odpowiedź

Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.

Schematy danych odpowiedzi: RedeemCode. Pola i typy — na stronach „Schematy danych”.

Schemat odpowiedzi, wartości przykładowe
{
  "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)"
  }
}

Cechy szczególne: Wszystkie dane osobowe i obiekty są ograniczone do podmiotu JWT.

Dodatkowe pytania? Prześlij Request ID i opis — pomożemy wyjaśnić sprawę.Napisz do wsparcia