Fiók-API

Bejelentkezés és munkamenetek

Metódusok, kérésmezők és válaszok.

Teljes útmutató

Ebben a részben 14 metódus található. Nyissa meg a metódust a hozzáférési feltételek, a kérésmezők és a válasz megtekintéséhez.

Metódus és útvonal	Leírás	Hozzáférés
`POST /api/v1/auth/forgot-password`	Jelszó-visszaállítás kérése	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/login`	Bejelentkezés e-mail-címmel és jelszóval	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/login/2fa`	TOTP-bejelentkezés befejezése	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/logout`	Kijelentkezés és a refresh token visszavonása	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`GET /api/v1/auth/me`	Aktuális felhasználó, egyenleg és korlátok	Fióktoken
`POST /api/v1/auth/passkey/login/begin`	Bejelentkezés indítása passkey használatával	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/passkey/login/finish`	Bejelentkezés befejezése passkey használatával	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/refresh`	Tokenek frissítése	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/register`	Regisztráció	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/reset-password`	Jelszó visszaállítása	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/revoke-all-sessions`	Minden munkamenet visszavonása	Fióktoken
`POST /api/v1/auth/send-verify-code`	Megerősítő kód küldése	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/validate-invitation-code`	Meghívó ellenőrzése	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti
`POST /api/v1/auth/validate-promo-code`	Promóciós kód ellenőrzése	Bejelentkezés nélkül; a további feltételeket a metódus ismerteti

POST /api/v1/auth/forgot-password — Jelszó-visszaállítás kérése

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

Gyakorisági korlát: 5 kérés 60 másodperc alatt egy címről.

POST/api/v1/auth/forgot-password

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`email`	`string`	igen	required,email
`turnstile_token`	`string`	nem

Kéréstörzs-sablon

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

A PLACEHOLDER az Ön által megadandó értéket és annak típusát jelöli. Cserélje ki az értékeket, és csak a szükséges nem kötelező mezőket tartsa meg; karakterlánc-jelölők nem küldhetők számok, boolean értékek, objektumok vagy tömbök helyett.

A kérés sémája: ForgotPasswordRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: ForgotPasswordResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/login — Bejelentkezés e-mail-címmel és jelszóval

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 20 kérés 60 másodperc alatt egy címről.

POST/api/v1/auth/login

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`email`	`string`	igen	required,email
`password`	`string`	igen	required
`turnstile_token`	`string`	nem

Kéréstörzs-sablon

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

A kérés sémája: LoginRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: TotpLoginResponse, User, AuthResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Ha többféle válasz lehetséges, a mezőiket külön sémák sorolják fel; ezeket nem szabad egyetlen objektummá egyesíteni.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/login/2fa — TOTP-bejelentkezés befejezése

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 20 kérés 60 másodperc alatt egy címről.

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

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`temp_token`	`string`	igen	required
`totp_code`	`string`	igen	required,len=6

Kéréstörzs-sablon

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

A kérés sémája: Login2FARequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: User, AuthResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Ha többféle válasz lehetséges, a mezőiket külön sémák sorolják fel; ezeket nem szabad egyetlen objektummá egyesíteni.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/logout — Kijelentkezés és a refresh token visszavonása

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

POST/api/v1/auth/logout

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`refresh_token`	`string`	nem	; Nem kötelező: a megadott frissítési token visszavonása

Kéréstörzs-sablon

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

A kérés sémája: LogoutRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: LogoutResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

GET /api/v1/auth/me — Aktuális felhasználó, egyenleg és korlátok

Hozzáférés: fióktoken

GET/api/v1/auth/me

Olvasás; az azonosító a korábbi válaszából származik

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

A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: User, UserProfileResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a kulcsok költési korlátai (quota, quota_used) a kulcsok válaszában érkeznek, nem a profilban. A frozen_balance zárolt összeg, nem tekinthető szabad egyenlegnek.

POST /api/v1/auth/passkey/login/begin — Bejelentkezés indítása passkey használatával

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 20 kérés 60 másodperc alatt egy címről.

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

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`turnstile_token`	`string`	nem

Kéréstörzs-sablon

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

A kérés sémája: PasskeyBeginLoginRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: PasskeyOptionsResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

Sajátosságok: a credential a navigator.credentials eredménye; a session_token a begin válaszából származik. Finish body <=65536 bájt; a regisztrációhoz és törléshez jelszó szükséges.

POST /api/v1/auth/passkey/login/finish — Bejelentkezés befejezése passkey használatával

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 20 kérés 60 másodperc alatt egy címről.

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

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`session_token`	`string`	igen	required
`name`	`string`	nem
`credential`	`object`	igen	required

Kéréstörzs-sablon

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

A kérés sémája: PasskeyFinishRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: User, AuthResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Ha többféle válasz lehetséges, a mezőiket külön sémák sorolják fel; ezeket nem szabad egyetlen objektummá egyesíteni.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

Sajátosságok: a credential a navigator.credentials eredménye; a session_token a begin válaszából származik. Finish body <=65536 bájt; a regisztrációhoz és törléshez jelszó szükséges.

POST /api/v1/auth/refresh — Tokenek frissítése

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 30 kérés 60 másodperc alatt egy címről.

POST/api/v1/auth/refresh

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`refresh_token`	`string`	igen	required

Kéréstörzs-sablon

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

A kérés sémája: RefreshTokenRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: RefreshTokenResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/register — Regisztráció

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

Gyakorisági korlát: 5 kérés 60 másodperc alatt egy címről.

POST/api/v1/auth/register

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`email`	`string`	igen	required,email
`password`	`string`	igen	required,min=6
`verify_code`	`string`	nem
`turnstile_token`	`string`	nem
`promo_code`	`string`	nem	; Regisztrációs promóciós kód
`invitation_code`	`string`	nem	; Meghívókód

Kéréstörzs-sablon

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

A kérés sémája: RegisterRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: User, AuthResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Ha többféle válasz lehetséges, a mezőiket külön sémák sorolják fel; ezeket nem szabad egyetlen objektummá egyesíteni.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/reset-password — Jelszó visszaállítása

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

Gyakorisági korlát: 10 kérés 60 másodperc alatt egy címről.

POST/api/v1/auth/reset-password

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`email`	`string`	igen	required,email
`token`	`string`	igen	required
`new_password`	`string`	igen	required,min=6

Kéréstörzs-sablon

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

A kérés sémája: ResetPasswordRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: ResetPasswordResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/revoke-all-sessions — Minden munkamenet visszavonása

Hozzáférés: fióktoken

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

A kéréshez nem szükséges törzs.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: RevokeAllSessionsResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/send-verify-code — Megerősítő kód küldése

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

Gyakorisági korlát: 5 kérés 60 másodperc alatt egy címről.

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

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`email`	`string`	igen	required,email
`turnstile_token`	`string`	nem

Kéréstörzs-sablon

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

A kérés sémája: SendVerifyCodeRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: SendVerifyCodeResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/validate-invitation-code — Meghívó ellenőrzése

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 10 kérés 60 másodperc alatt egy címről.

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

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`code`	`string`	igen	required

Kéréstörzs-sablon

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

A kérés sémája: ValidateInvitationCodeRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: ValidateInvitationCodeResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a metódus ellenőrzi a meghívót, és nem váltja be a kódot; a példa a szerződést írja le, és nem kerül végrehajtásra.

POST /api/v1/auth/validate-promo-code — Promóciós kód ellenőrzése

Hozzáférés: bejelentkezés nélkül; a további feltételeket a metódus ismerteti

A funkció elérhetőségét és a további hozzáférési feltételeket a kérés végrehajtásakor ellenőrizzük.

Gyakorisági korlát: 10 kérés 60 másodperc alatt egy címről.

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

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`code`	`string`	igen	required

Kéréstörzs-sablon

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

A kérés sémája: ValidatePromoCodeRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: ValidatePromoCodeResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: a metódus ellenőrzi a promóciós kódot, és nem ír jóvá bónuszt; a példa a szerződést írja le, és nem kerül végrehajtásra.

Bejelentkezés és munkamenetek · 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

Maradt kérdése? Küldje el a Request ID-t és a probléma leírását — segítünk tisztázni.Írjon a támogatásnak