Innlogging og økter
MarkdownMetoder, forespørselsfelter og svar.
Fullstendig guide
Seksjonen har 14 metoder. Åpne en metode for å se tilgangsvilkår, forespørselsfelter og svar.
| Metode og endepunkt | Beskrivelse | Tilgang |
|---|---|---|
POST /api/v1/auth/forgot-password | Be om tilbakestilling av passord | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/login | Innlogging med e-post og passord | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/login/2fa | Fullfør innlogging med TOTP | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/logout | Utlogging og tilbakekalling av oppdateringstoken | Uten innlogging; ytterligere vilkår er angitt for metoden |
GET /api/v1/auth/me | Gjeldende bruker, saldo og grenser | Kontrollpaneltoken |
POST /api/v1/auth/passkey/login/begin | Start innlogging med passnøkkel | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/passkey/login/finish | Fullfør innlogging med passnøkkel | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/refresh | Forny tokener | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/register | Registrer deg | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/reset-password | Tilbakestill passord | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/revoke-all-sessions | Tilbakekall alle økter | Kontrollpaneltoken |
POST /api/v1/auth/send-verify-code | Send bekreftelseskode | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/validate-invitation-code | Valider invitasjon | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/validate-promo-code | Valider kampanjekode | Uten innlogging; ytterligere vilkår er angitt for metoden |
POST /api/v1/auth/forgot-password — Be om tilbakestilling av passord
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Frekvensgrense: 5 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/forgot-passwordJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
email | string | ja | required,email |
turnstile_token | string | nei |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: ForgotPasswordRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: ForgotPasswordResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/login — Innlogging med e-post og passord
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 20 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/loginJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
email | string | ja | required,email |
password | string | ja | required |
turnstile_token | string | nei |
{
"email": "PLACEHOLDER_EMAIL (string)",
"password": "PLACEHOLDER_PASSWORD (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: LoginRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: TotpLoginResponse, User, AuthResponse. Felter og typer finnes på sidene «Dataskjemaer».
Hvis flere svarvarianter er mulige, er feltene angitt i separate skjemaer; de skal ikke kombineres i ett objekt.
Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/login/2fa — Fullfør innlogging med TOTP
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 20 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/login/2faJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
temp_token | string | ja | required |
totp_code | string | ja | required,len=6 |
{
"temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
"totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: Login2FARequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: User, AuthResponse. Felter og typer finnes på sidene «Dataskjemaer».
Hvis flere svarvarianter er mulige, er feltene angitt i separate skjemaer; de skal ikke kombineres i ett objekt.
Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/logout — Utlogging og tilbakekalling av oppdateringstoken
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
/api/v1/auth/logoutJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
refresh_token | string | nei | ; Valgfritt: tilbakekall det angitte oppdateringstokenet |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: LogoutRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: LogoutResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
GET /api/v1/auth/me — Gjeldende bruker, saldo og grenser
Tilgang: kontrollpaneltoken
/api/v1/auth/mecurl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
-H "Authorization: Bearer $TOKEN"Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: User, UserProfileResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"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)"
}
}Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.
Merknader: Nøklenes forbruksgrenser (quota, quota_used) returneres i nøkkelsvaret, ikke i profilen. frozen_balance er det reserverte beløpet og må ikke regnes som tilgjengelig saldo.
POST /api/v1/auth/passkey/login/begin — Start innlogging med passnøkkel
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 20 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/passkey/login/beginJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
turnstile_token | string | nei |
{
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: PasskeyBeginLoginRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: PasskeyOptionsResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"options": "PLACEHOLDER_OPTIONS (any)"
}
}Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
Merknader: credential hentes fra navigator.credentials; session_token fra begin. Forespørselskroppen til Finish <=65536 byte; registrering og sletting krever passord.
POST /api/v1/auth/passkey/login/finish — Fullfør innlogging med passnøkkel
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 20 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/passkey/login/finishJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
session_token | string | ja | required |
name | string | nei | |
credential | object | ja | required |
{
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"name": "PLACEHOLDER_NAME (string)",
"credential": "PLACEHOLDER_CREDENTIAL (object)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: PasskeyFinishRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: User, AuthResponse. Felter og typer finnes på sidene «Dataskjemaer».
Hvis flere svarvarianter er mulige, er feltene angitt i separate skjemaer; de skal ikke kombineres i ett objekt.
Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
Merknader: credential hentes fra navigator.credentials; session_token fra begin. Forespørselskroppen til Finish <=65536 byte; registrering og sletting krever passord.
POST /api/v1/auth/refresh — Forny tokener
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 30 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/refreshJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
refresh_token | string | ja | required |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: RefreshTokenRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: RefreshTokenResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"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)"
}
}Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/register — Registrering
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Frekvensgrense: 5 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/registerJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
email | string | ja | required,email |
password | string | ja | required,min=6 |
verify_code | string | nei | |
turnstile_token | string | nei | |
promo_code | string | nei | ; Kampanjekode ved registrering |
invitation_code | string | nei | ; Invitasjonskode |
{
"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 angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: RegisterRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: User, AuthResponse. Felter og typer finnes på sidene «Dataskjemaer».
Hvis flere svarvarianter er mulige, er feltene angitt i separate skjemaer; de skal ikke kombineres i ett objekt.
Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/reset-password — Tilbakestill passord
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Frekvensgrense: 10 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/reset-passwordJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
email | string | ja | required,email |
token | string | ja | required |
new_password | string | ja | required,min=6 |
{
"email": "PLACEHOLDER_EMAIL (string)",
"token": "PLACEHOLDER_TOKEN (string)",
"new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: ResetPasswordRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: ResetPasswordResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/revoke-all-sessions — Tilbakekall alle økter
Tilgang: kontrollpaneltoken
/api/v1/auth/revoke-all-sessionsForespørselskropp er ikke nødvendig.
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: RevokeAllSessionsResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.
Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/send-verify-code — Send bekreftelseskode
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Frekvensgrense: 5 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/send-verify-codeJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
email | string | ja | required,email |
turnstile_token | string | nei |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: SendVerifyCodeRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: SendVerifyCodeResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)",
"countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}
}Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/validate-invitation-code — Valider invitasjon
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 10 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/validate-invitation-codeJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
code | string | ja | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: ValidateInvitationCodeRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: ValidateInvitationCodeResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"code": 0,
"message": "success",
"data": {
"valid": "PLACEHOLDER_VALID (boolean)",
"error_code": "PLACEHOLDER_ERROR_CODE (string)"
}
}Merknader: Metoden kontrollerer invitasjonen uten å markere koden som brukt; eksemplet beskriver kontrakten og utføres ikke.
POST /api/v1/auth/validate-promo-code — Valider kampanjekode
Tilgang: uten innlogging; ytterligere vilkår er angitt for metoden
Funksjonens tilgjengelighet og ytterligere tilgangsvilkår kontrolleres når forespørselen utføres.
Frekvensgrense: 10 forespørsler per 60 sekunder fra samme adresse.
/api/v1/auth/validate-promo-codeJSON- / skjemafelter
| Feltet | Type | Påkrevd | Validering / beskrivelse |
|---|---|---|---|
code | string | ja | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.
Forespørselsskjema: ValidatePromoCodeRequest
Svar
JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.
Dataskjemaer for svaret: ValidatePromoCodeResponse. Felter og typer finnes på sidene «Dataskjemaer».
{
"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)"
}
}Merknader: Metoden kontrollerer kampanjekoden uten å tildele noen bonus; eksemplet beskriver kontrakten og utføres ikke.
Innlogging og økter · 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