Prijava in seje
MarkdownMetode, polja zahtev in odgovori.
Celoten vodnik
V razdelku je 14 metod. Odprite metodo, da si ogledate pogoje dostopa, polja zahteve in odgovor.
| Metoda in pot | Opis | Dostop |
|---|---|---|
POST /api/v1/auth/forgot-password | Zahteva za ponastavitev gesla | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/login | Prijava z e-poštnim naslovom in geslom | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/login/2fa | Zaključek prijave s TOTP | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/logout | Odjava in preklic osvežitvenega žetona | Brez prijave; dodatni pogoji so navedeni pri metodi |
GET /api/v1/auth/me | Trenutni uporabnik, stanje in omejitve | Žeton nadzorne plošče |
POST /api/v1/auth/passkey/login/begin | Začetek prijave s ključem za dostop | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/passkey/login/finish | Zaključek prijave s ključem za dostop | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/refresh | Osvežitev žetonov | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/register | Registracija | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/reset-password | Ponastavitev gesla | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/revoke-all-sessions | Preklic vseh sej | Žeton nadzorne plošče |
POST /api/v1/auth/send-verify-code | Pošiljanje potrditvene kode | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/validate-invitation-code | Preverjanje povabila | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/validate-promo-code | Preverjanje promocijske kode | Brez prijave; dodatni pogoji so navedeni pri metodi |
POST /api/v1/auth/forgot-password – Zahteva za ponastavitev gesla
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Omejitev pogostosti: 5 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/forgot-passwordPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
email | string | da | required,email |
turnstile_token | string | ne |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: ForgotPasswordRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: ForgotPasswordResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/login – Prijava z e-poštnim naslovom in geslom
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 20 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/loginPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
email | string | da | required,email |
password | string | da | required |
turnstile_token | string | ne |
{
"email": "PLACEHOLDER_EMAIL (string)",
"password": "PLACEHOLDER_PASSWORD (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: LoginRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: TotpLoginResponse, User, AuthResponse. Polja in vrste so na straneh »Podatkovne sheme«.
Če je možnih več različic odgovora, so njihova polja navedena v ločenih shemah; ne združujte jih v en objekt.
Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/login/2fa – Zaključek prijave s TOTP
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 20 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/login/2faPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
temp_token | string | da | required |
totp_code | string | da | required,len=6 |
{
"temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
"totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: Login2FARequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: User, AuthResponse. Polja in vrste so na straneh »Podatkovne sheme«.
Če je možnih več različic odgovora, so njihova polja navedena v ločenih shemah; ne združujte jih v en objekt.
Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/logout – Odjava in preklic osvežitvenega žetona
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
/api/v1/auth/logoutPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
refresh_token | string | ne | ; Neobvezno: preklic navedenega osvežitvenega žetona |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: LogoutRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: LogoutResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
GET /api/v1/auth/me – Trenutni uporabnik, stanje in omejitve
Dostop: Žeton nadzorne plošče
/api/v1/auth/mecurl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
-H "Authorization: Bearer $TOKEN"Telo zahteve ni potrebno. Zgoraj navedene parametre pošljite v URL.
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: User, UserProfileResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"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)"
}
}Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.
Posebnosti: Omejitve porabe ključev (quota, quota_used) so v odgovoru za ključe, ne v profilu. frozen_balance je rezervirani znesek, zato ga ne smete šteti za prosta sredstva.
POST /api/v1/auth/passkey/login/begin – Začetek prijave s ključem za dostop
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 20 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/passkey/login/beginPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
turnstile_token | string | ne |
{
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: PasskeyBeginLoginRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: PasskeyOptionsResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"options": "PLACEHOLDER_OPTIONS (any)"
}
}Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
Posebnosti: credential je pridobljen iz navigator.credentials; session_token iz begin. Telo zahteve Finish <=65536 bajtov; registracija in odstranjevanje zahtevata geslo.
POST /api/v1/auth/passkey/login/finish – Zaključek prijave s ključem za dostop
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 20 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/passkey/login/finishPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
session_token | string | da | required |
name | string | ne | |
credential | object | da | required |
{
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"name": "PLACEHOLDER_NAME (string)",
"credential": "PLACEHOLDER_CREDENTIAL (object)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: PasskeyFinishRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: User, AuthResponse. Polja in vrste so na straneh »Podatkovne sheme«.
Če je možnih več različic odgovora, so njihova polja navedena v ločenih shemah; ne združujte jih v en objekt.
Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
Posebnosti: credential je pridobljen iz navigator.credentials; session_token iz begin. Telo zahteve Finish <=65536 bajtov; registracija in odstranjevanje zahtevata geslo.
POST /api/v1/auth/refresh – Osvežitev žetonov
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 30 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/refreshPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
refresh_token | string | da | required |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: RefreshTokenRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: RefreshTokenResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"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)"
}
}Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/register – Registracija
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Omejitev pogostosti: 5 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/registerPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
email | string | da | required,email |
password | string | da | required,min=6 |
verify_code | string | ne | |
turnstile_token | string | ne | |
promo_code | string | ne | ; Promocijska koda za registracijo |
invitation_code | string | ne | ; Koda povabila |
{
"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 označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: RegisterRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: User, AuthResponse. Polja in vrste so na straneh »Podatkovne sheme«.
Če je možnih več različic odgovora, so njihova polja navedena v ločenih shemah; ne združujte jih v en objekt.
Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/reset-password – Ponastavitev gesla
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Omejitev pogostosti: 10 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/reset-passwordPolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
email | string | da | required,email |
token | string | da | required |
new_password | string | da | required,min=6 |
{
"email": "PLACEHOLDER_EMAIL (string)",
"token": "PLACEHOLDER_TOKEN (string)",
"new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: ResetPasswordRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: ResetPasswordResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/revoke-all-sessions – Preklic vseh sej
Dostop: Žeton nadzorne plošče
/api/v1/auth/revoke-all-sessionsTelo zahteve ni potrebno.
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: RevokeAllSessionsResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.
Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/send-verify-code – Pošiljanje potrditvene kode
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Omejitev pogostosti: 5 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/send-verify-codePolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
email | string | da | required,email |
turnstile_token | string | ne |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: SendVerifyCodeRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: SendVerifyCodeResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)",
"countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}
}Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.
POST /api/v1/auth/validate-invitation-code – Preverjanje povabila
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 10 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/validate-invitation-codePolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
code | string | da | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: ValidateInvitationCodeRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: ValidateInvitationCodeResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"code": 0,
"message": "success",
"data": {
"valid": "PLACEHOLDER_VALID (boolean)",
"error_code": "PLACEHOLDER_ERROR_CODE (string)"
}
}Posebnosti: Metoda preveri povabilo in kode ne porabi; primer opisuje pogodbo API in se ne izvede.
POST /api/v1/auth/validate-promo-code – Preverjanje promocijske kode
Dostop: Brez prijave; dodatni pogoji so navedeni pri metodi
Razpoložljivost funkcije in dodatni pogoji dostopa se preverijo ob izvedbi zahteve.
Omejitev pogostosti: 10 zahtev v 60 sekundah z istega naslova.
/api/v1/auth/validate-promo-codePolja JSON / obrazca
| Polje | Vrsta | Obvezno | Preverjanje / opis |
|---|---|---|---|
code | string | da | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.
Shema zahteve: ValidatePromoCodeRequest
Odgovor
Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.
Podatkovne sheme odgovora: ValidatePromoCodeResponse. Polja in vrste so na straneh »Podatkovne sheme«.
{
"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)"
}
}Posebnosti: Metoda preveri promocijsko kodo in ne pripiše bonusa; primer opisuje pogodbo API in se ne izvede.
Prijava in seje · 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_tokendata.access_token→ AuthResponse →Authorization: Bearer $TOKEN
totp_code: string, len = 6. temp_token ≠ access_token. User