Кіру және сеанстар

Әдістер, сұрау өрістері және жауаптар.

Толық нұсқаулық

Бөлімде 14 әдіс бар. Қол жеткізу шарттарын, сұрау өрістерін және жауапты көру үшін әдісті ашыңыз.

Әдіс және жол	Сипаттамасы	Қол жеткізу
`POST /api/v1/auth/forgot-password`	Құпиясөзді қалпына келтіруге сұрау	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/login`	Электрондық пошта және құпиясөзбен кіру	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/login/2fa`	TOTP арқылы кіруді аяқтау	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/logout`	Шығу және refresh token қайтарып алу	Кірусіз; қосымша шарттар әдісте көрсетілген
`GET /api/v1/auth/me`	Ағымдағы пайдаланушы, баланс және лимиттер	Жеке кабинет токені
`POST /api/v1/auth/passkey/login/begin`	Passkey арқылы кіруді бастау	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/passkey/login/finish`	Passkey арқылы кіруді аяқтау	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/refresh`	Токендерді жаңарту	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/register`	Тіркелу	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/reset-password`	Құпиясөзді қалпына келтіру	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/revoke-all-sessions`	Барлық сеансты қайтарып алу	Жеке кабинет токені
`POST /api/v1/auth/send-verify-code`	Растау кодын жіберу	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/validate-invitation-code`	Шақыруды тексеру	Кірусіз; қосымша шарттар әдісте көрсетілген
`POST /api/v1/auth/validate-promo-code`	Промокодты тексеру	Кірусіз; қосымша шарттар әдісте көрсетілген

POST /api/v1/auth/forgot-password — Құпиясөзді қалпына келтіруге сұрау

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Жиілік лимиті: бір мекенжайдан 60 секундта 5 сұрау.

POST/api/v1/auth/forgot-password

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`email`	`string`	иә	required,email
`turnstile_token`	`string`	жоқ

Сұрау денесінің үлгісі

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PLACEHOLDER енгізетін мәніңіз бен оның түрін білдіреді. Мәндерді ауыстырып, тек қажетті міндетті емес өрістерді қалдырыңыз; жолдық маркерлер сандардың, boolean мәндерінің, нысандардың немесе массивтердің орнына жіберілмейді.

Сұрау схемасы: ForgotPasswordRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: ForgotPasswordResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ерекшеліктер: операция күйді өзгертеді немесе бір реттік авторизацияны жалғастырады; мысал шартты сипаттайды және орындалмайды.

POST /api/v1/auth/login — Электрондық пошта және құпиясөзбен кіру

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 20 сұрау.

POST/api/v1/auth/login

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`email`	`string`	иә	required,email
`password`	`string`	иә	required
`turnstile_token`	`string`	жоқ

Сұрау денесінің үлгісі

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

Сұрау схемасы: LoginRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: TotpLoginResponse, User, AuthResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Бірнеше жауап нұсқасы болуы мүмкін болса, олардың өрістері бөлек схемаларда көрсетіледі; оларды бір нысанға біріктіруге болмайды.

POST /api/v1/auth/login/2fa — TOTP арқылы кіруді аяқтау

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 20 сұрау.

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

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`temp_token`	`string`	иә	required
`totp_code`	`string`	иә	required,len=6

Сұрау денесінің үлгісі

{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

Сұрау схемасы: Login2FARequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: User, AuthResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

POST /api/v1/auth/logout — Шығу және refresh token қайтарып алу

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

POST/api/v1/auth/logout

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`refresh_token`	`string`	жоқ	; Міндетті емес: көрсетілген жаңарту токенін қайтарып алу

Сұрау денесінің үлгісі

{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

Сұрау схемасы: LogoutRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: LogoutResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

GET /api/v1/auth/me — Ағымдағы пайдаланушы, баланс және лимиттер

Қол жеткізу: жеке кабинет токені

GET/api/v1/auth/me

Оқу; ID алдыңғы жауабыңыздан алынады

curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"

Сұрау денесі қажет емес. Жоғарыда көрсетілген параметрлерді URL ішінде жіберіңіз.

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: User, UserProfileResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "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)"
  }
}

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

Ерекшеліктер: кілттердің шығын лимиттері (quota, quota_used) профильде емес, кілттер жауабында келеді. frozen_balance — резервтелген сома, оны бос баланс деп санауға болмайды.

POST /api/v1/auth/passkey/login/begin — Passkey арқылы кіруді бастау

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 20 сұрау.

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

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`turnstile_token`	`string`	жоқ

Сұрау денесінің үлгісі

{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

Сұрау схемасы: PasskeyBeginLoginRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: PasskeyOptionsResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}

Ерекшеліктер: credential navigator.credentials арқылы алынады; session_token begin арқылы алынады. Finish body <=65536 байт; тіркеу мен жою үшін құпиясөз қажет.

POST /api/v1/auth/passkey/login/finish — Passkey арқылы кіруді аяқтау

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 20 сұрау.

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

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`session_token`	`string`	иә	required
`name`	`string`	жоқ
`credential`	`object`	иә	required

Сұрау денесінің үлгісі

{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

Сұрау схемасы: PasskeyFinishRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: User, AuthResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

POST /api/v1/auth/refresh — Токендерді жаңарту

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 30 сұрау.

POST/api/v1/auth/refresh

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`refresh_token`	`string`	иә	required

Сұрау денесінің үлгісі

{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

Сұрау схемасы: RefreshTokenRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: RefreshTokenResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "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)"
  }
}

POST /api/v1/auth/register — Тіркелу

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Жиілік лимиті: бір мекенжайдан 60 секундта 5 сұрау.

POST/api/v1/auth/register

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`email`	`string`	иә	required,email
`password`	`string`	иә	required,min=6
`verify_code`	`string`	жоқ
`turnstile_token`	`string`	жоқ
`promo_code`	`string`	жоқ	; Тіркелу промокоды
`invitation_code`	`string`	жоқ	; Шақыру коды

Сұрау денесінің үлгісі

{
  "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)"
}

Сұрау схемасы: RegisterRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: User, AuthResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

POST /api/v1/auth/reset-password — Құпиясөзді қалпына келтіру

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Жиілік лимиті: бір мекенжайдан 60 секундта 10 сұрау.

POST/api/v1/auth/reset-password

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`email`	`string`	иә	required,email
`token`	`string`	иә	required
`new_password`	`string`	иә	required,min=6

Сұрау денесінің үлгісі

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

Сұрау схемасы: ResetPasswordRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: ResetPasswordResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

POST /api/v1/auth/revoke-all-sessions — Барлық сеансты қайтарып алу

Қол жеткізу: жеке кабинет токені

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

Сұрау денесі қажет емес.

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: RevokeAllSessionsResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

Ерекшеліктер: барлық жеке дерек пен нысан JWT субъектісімен шектелген.

POST /api/v1/auth/send-verify-code — Растау кодын жіберу

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Жиілік лимиті: бір мекенжайдан 60 секундта 5 сұрау.

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

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`email`	`string`	иә	required,email
`turnstile_token`	`string`	жоқ

Сұрау денесінің үлгісі

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

Сұрау схемасы: SendVerifyCodeRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: SendVerifyCodeResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}

POST /api/v1/auth/validate-invitation-code — Шақыруды тексеру

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 10 сұрау.

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

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`code`	`string`	иә	required

Сұрау денесінің үлгісі

{
  "code": "PLACEHOLDER_CODE (string)"
}

Сұрау схемасы: ValidateInvitationCodeRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: ValidateInvitationCodeResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}

Ерекшеліктер: әдіс шақыруды тексереді және кодты жұмсамайды; мысал шартты сипаттайды және орындалмайды.

POST /api/v1/auth/validate-promo-code — Промокодты тексеру

Қол жеткізу: кірусіз; қосымша шарттар әдісте көрсетілген

Функцияның қолжетімділігі мен қосымша қол жеткізу шарттары сұрау орындалғанда тексеріледі.

Жиілік лимиті: бір мекенжайдан 60 секундта 10 сұрау.

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

JSON / форма өрістері

Өріс	Түрі	Міндетті	Тексеру / сипаттама
`code`	`string`	иә	required

Сұрау денесінің үлгісі

{
  "code": "PLACEHOLDER_CODE (string)"
}

Сұрау схемасы: ValidatePromoCodeRequest

Жауап

JSON жауабында code, message және data бар. data мазмұны төмендегі схемаларда сипатталған.

Жауап деректерінің схемалары: ValidatePromoCodeResponse. Өрістер мен түрлер «Деректер схемалары» беттерінде берілген.

Жауап схемасы, мәндері шартты

{
  "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)"
  }
}

Ерекшеліктер: әдіс промокодты тексереді және бонус бермейді; мысал шартты сипаттайды және орындалмайды.

Кіру және сеанстар · 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

Сұрақтарыңыз қалды ма? Request ID мен сипаттаманы жіберіңіз — мәселені анықтауға көмектесеміз.Қолдау қызметіне жазу