docs
Paskyra
Paskyros API

Prisijungimas ir seansai

Markdown

Metodai, užklausų laukai ir atsakymai.

Visas vadovas

Skiltyje yra 14 metodų. Atverkite metodą, kad peržiūrėtumėte prieigos sąlygas, užklausos laukus ir atsakymą.

Metodas ir keliasAprašymasPrieiga
POST /api/v1/auth/forgot-passwordSlaptažodžio atkūrimo užklausaNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/loginPrisijungimas el. paštu ir slaptažodžiuNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/login/2faPrisijungimo užbaigimas su TOTPNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/logoutAtsijungimas ir refresh token atšaukimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
GET /api/v1/auth/meDabartinis vartotojas, balansas ir limitaiPaskyros žetonas
POST /api/v1/auth/passkey/login/beginPrisijungimo su passkey pradžiaNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/passkey/login/finishPrisijungimo su passkey užbaigimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/refreshŽetonų atnaujinimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/registerRegistruotisNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/reset-passwordSlaptažodžio atkūrimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/revoke-all-sessionsVisų seansų atšaukimasPaskyros žetonas
POST /api/v1/auth/send-verify-codePatvirtinimo kodo siuntimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/validate-invitation-codeKvietimo tikrinimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/validate-promo-codeNuolaidos kodo tikrinimasNeprisijungus; papildomos sąlygos nurodytos prie metodo
POST /api/v1/auth/forgot-password — Slaptažodžio atkūrimo užklausa

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Dažnio limitas: 5 užklausos per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/forgot-password

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
emailstringtaiprequired,email
turnstile_tokenstringne
Užklausos turinio šablonas
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: ForgotPasswordRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: ForgotPasswordResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/login — Prisijungimas el. paštu ir slaptažodžiu

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 20 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/login

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
emailstringtaiprequired,email
passwordstringtaiprequired
turnstile_tokenstringne
Užklausos turinio šablonas
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: LoginRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: TotpLoginResponse, User, AuthResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Jei galimi keli atsakymo variantai, jų laukai išvardyti atskirose schemose; nereikėtų jų jungti į vieną objektą.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/login/2fa — Prisijungimo užbaigimas su TOTP

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 20 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/login/2fa

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
temp_tokenstringtaiprequired
totp_codestringtaiprequired,len=6
Užklausos turinio šablonas
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: Login2FARequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: User, AuthResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Jei galimi keli atsakymo variantai, jų laukai išvardyti atskirose schemose; nereikėtų jų jungti į vieną objektą.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/logout — Atsijungimas ir refresh token atšaukimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

POST/api/v1/auth/logout

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
refresh_tokenstringne; Neprivaloma: atšaukti nurodytą atnaujinimo žetoną
Užklausos turinio šablonas
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: LogoutRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: LogoutResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

GET /api/v1/auth/me — Dabartinis vartotojas, balansas ir limitai

Prieiga: paskyros žetonas

GET/api/v1/auth/me
Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo
curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"

Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: User, UserProfileResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: raktų išlaidų limitai (quota, quota_used) pateikiami raktų atsakyme, o ne profilyje. frozen_balance — rezervuota suma, jos negalima laikyti laisvu balansu.

POST /api/v1/auth/passkey/login/begin — Prisijungimo su passkey pradžia

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 20 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/passkey/login/begin

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
turnstile_tokenstringne
Užklausos turinio šablonas
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: PasskeyBeginLoginRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: PasskeyOptionsResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

Ypatybės: credential gautas iš navigator.credentials; session_token — iš begin. Finish body <=65536 baitų; registravimui ir šalinimui reikia slaptažodžio.

POST /api/v1/auth/passkey/login/finish — Prisijungimo su passkey užbaigimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 20 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/passkey/login/finish

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
session_tokenstringtaiprequired
namestringne
credentialobjecttaiprequired
Užklausos turinio šablonas
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: PasskeyFinishRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: User, AuthResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Jei galimi keli atsakymo variantai, jų laukai išvardyti atskirose schemose; nereikėtų jų jungti į vieną objektą.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

Ypatybės: credential gautas iš navigator.credentials; session_token — iš begin. Finish body <=65536 baitų; registravimui ir šalinimui reikia slaptažodžio.

POST /api/v1/auth/refresh — Žetonų atnaujinimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 30 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/refresh

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
refresh_tokenstringtaiprequired
Užklausos turinio šablonas
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: RefreshTokenRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: RefreshTokenResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
    "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
    "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
    "token_type": "PLACEHOLDER_TOKEN_TYPE (string)"
  }
}

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/register — Registracija

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Dažnio limitas: 5 užklausos per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/register

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
emailstringtaiprequired,email
passwordstringtaiprequired,min=6
verify_codestringne
turnstile_tokenstringne
promo_codestringne; Registracijos nuolaidos kodas
invitation_codestringne; Kvietimo kodas
Užklausos turinio šablonas
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "verify_code": "PLACEHOLDER_VERIFY_CODE (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)",
  "promo_code": "PLACEHOLDER_PROMO_CODE (string)",
  "invitation_code": "PLACEHOLDER_INVITATION_CODE (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: RegisterRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: User, AuthResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Jei galimi keli atsakymo variantai, jų laukai išvardyti atskirose schemose; nereikėtų jų jungti į vieną objektą.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/reset-password — Slaptažodžio atkūrimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Dažnio limitas: 10 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/reset-password

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
emailstringtaiprequired,email
tokenstringtaiprequired
new_passwordstringtaiprequired,min=6
Užklausos turinio šablonas
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: ResetPasswordRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: ResetPasswordResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/revoke-all-sessions — Visų seansų atšaukimas

Prieiga: paskyros žetonas

POST/api/v1/auth/revoke-all-sessions

Užklausos turinio nereikia.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: RevokeAllSessionsResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/send-verify-code — Patvirtinimo kodo siuntimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Dažnio limitas: 5 užklausos per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/send-verify-code

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
emailstringtaiprequired,email
turnstile_tokenstringne
Užklausos turinio šablonas
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: SendVerifyCodeRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: SendVerifyCodeResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/validate-invitation-code — Kvietimo tikrinimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 10 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/validate-invitation-code

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
codestringtaiprequired
Užklausos turinio šablonas
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: ValidateInvitationCodeRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: ValidateInvitationCodeResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}

Ypatybės: metodas patikrina kvietimą ir nesunaudoja kodo; pavyzdys aprašo sutartį ir nėra vykdomas.

POST /api/v1/auth/validate-promo-code — Nuolaidos kodo tikrinimas

Prieiga: neprisijungus; papildomos sąlygos nurodytos prie metodo

Funkcijos prieinamumas ir papildomos prieigos sąlygos tikrinami vykdant užklausą.

Dažnio limitas: 10 užklausų per 60 sekundžių iš vieno adreso.

POST/api/v1/auth/validate-promo-code

JSON / formos laukai

LaukasTipasPrivalomaPatikra / aprašymas
codestringtaiprequired
Užklausos turinio šablonas
{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: ValidatePromoCodeRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: ValidatePromoCodeResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "bonus_amount": "PLACEHOLDER_BONUS_AMOUNT (number)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)",
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ypatybės: metodas patikrina reklaminį kodą ir nesuteikia premijos; pavyzdys aprašo sutartį ir nėra vykdomas.

Prisijungimas ir seansai · 2FA

POST /api/v1/auth/login → data

  • data.requires_2fa === true → TotpLoginResponse → data.temp_token → POST /api/v1/auth/login/2fa · {"temp_token": "…", "totp_code": "…"} → data.access_token
  • data.access_token → AuthResponse → Authorization: Bearer $TOKEN

totp_code: string, len = 6. temp_token ≠ access_token. User

Liko klausimų? Atsiųskite Request ID ir aprašymą — padėsime išsiaiškinti.Rašyti pagalbos tarnybai
PrisijungtiRegistruotisPaskyra
Planai