Logowanie i sesje
MarkdownMetody, pola żądań i odpowiedzi.
Pełny przewodnik
W tej sekcji jest 14 metod. Otwórz metodę, aby zobaczyć warunki dostępu, pola żądania i odpowiedź.
| Metoda i ścieżka | Opis | Dostęp |
|---|---|---|
POST /api/v1/auth/forgot-password | Żądanie zresetowania hasła | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/login | Logowanie adresem e-mail i hasłem | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/login/2fa | Zakończenie logowania z TOTP | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/logout | Wylogowanie i unieważnienie tokena odświeżania | Bez logowania; dodatkowe warunki podano przy metodzie |
GET /api/v1/auth/me | Bieżący użytkownik, saldo i limity | Token panelu użytkownika |
POST /api/v1/auth/passkey/login/begin | Rozpoczęcie logowania kluczem dostępu (passkey) | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/passkey/login/finish | Zakończenie logowania kluczem dostępu (passkey) | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/refresh | Odświeżenie tokenów | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/register | Rejestracja | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/reset-password | Reset hasła | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/revoke-all-sessions | Unieważnienie wszystkich sesji | Token panelu użytkownika |
POST /api/v1/auth/send-verify-code | Wysłanie kodu potwierdzającego | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/validate-invitation-code | Weryfikacja zaproszenia | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/validate-promo-code | Weryfikacja kodu promocyjnego | Bez logowania; dodatkowe warunki podano przy metodzie |
POST /api/v1/auth/forgot-password — Żądanie zresetowania hasła
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Limit częstotliwości: 5 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/forgot-passwordPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
email | string | tak | required,email |
turnstile_token | string | nie |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: ForgotPasswordRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: ForgotPasswordResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/login — Logowanie adresem e-mail i hasłem
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 20 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/loginPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
email | string | tak | required,email |
password | string | tak | required |
turnstile_token | string | nie |
{
"email": "PLACEHOLDER_EMAIL (string)",
"password": "PLACEHOLDER_PASSWORD (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: LoginRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: TotpLoginResponse, User, AuthResponse. Pola i typy — na stronach „Schematy danych”.
Jeśli możliwych jest kilka wariantów odpowiedzi, ich pola są wymienione w osobnych schematach; nie należy łączyć ich w jeden obiekt.
Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/login/2fa — Zakończenie logowania z TOTP
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 20 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/login/2faPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
temp_token | string | tak | required |
totp_code | string | tak | required,len=6 |
{
"temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
"totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: Login2FARequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: User, AuthResponse. Pola i typy — na stronach „Schematy danych”.
Jeśli możliwych jest kilka wariantów odpowiedzi, ich pola są wymienione w osobnych schematach; nie należy łączyć ich w jeden obiekt.
Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/logout — Wylogowanie i unieważnienie tokena odświeżania
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
/api/v1/auth/logoutPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
refresh_token | string | nie | ; Opcjonalnie: unieważnij wskazany token odświeżania |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: LogoutRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: LogoutResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
GET /api/v1/auth/me — Bieżący użytkownik, saldo i limity
Dostęp: Token panelu użytkownika
/api/v1/auth/mecurl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
-H "Authorization: Bearer $TOKEN"Treść żądania nie jest wymagana. Przekaż wskazane powyżej parametry w URL.
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: User, UserProfileResponse. Pola i typy — na stronach „Schematy danych”.
{
"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)"
}
}Cechy szczególne: Wszystkie dane osobowe i obiekty są ograniczone do podmiotu JWT.
Uwagi: limity wydatków kluczy (quota, quota_used) są zwracane w odpowiedzi z kluczami, a nie w profilu. frozen_balance to kwota zarezerwowana, nie można jej traktować jako wolnego salda.
POST /api/v1/auth/passkey/login/begin — Rozpoczęcie logowania kluczem dostępu (passkey)
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 20 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/passkey/login/beginPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
turnstile_token | string | nie |
{
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: PasskeyBeginLoginRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: PasskeyOptionsResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"options": "PLACEHOLDER_OPTIONS (any)"
}
}Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
Uwagi: credential pochodzi z navigator.credentials; session_token z begin. Treść żądania finish <=65536 bajtów; rejestracja i usunięcie wymagają hasła.
POST /api/v1/auth/passkey/login/finish — Zakończenie logowania kluczem dostępu (passkey)
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 20 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/passkey/login/finishPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
session_token | string | tak | required |
name | string | nie | |
credential | object | tak | required |
{
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"name": "PLACEHOLDER_NAME (string)",
"credential": "PLACEHOLDER_CREDENTIAL (object)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: PasskeyFinishRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: User, AuthResponse. Pola i typy — na stronach „Schematy danych”.
Jeśli możliwych jest kilka wariantów odpowiedzi, ich pola są wymienione w osobnych schematach; nie należy łączyć ich w jeden obiekt.
Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
Uwagi: credential pochodzi z navigator.credentials; session_token z begin. Treść żądania finish <=65536 bajtów; rejestracja i usunięcie wymagają hasła.
POST /api/v1/auth/refresh — Odświeżenie tokenów
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 30 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/refreshPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
refresh_token | string | tak | required |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: RefreshTokenRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: RefreshTokenResponse. Pola i typy — na stronach „Schematy danych”.
{
"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)"
}
}Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/register — Rejestracja
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Limit częstotliwości: 5 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/registerPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
email | string | tak | required,email |
password | string | tak | required,min=6 |
verify_code | string | nie | |
turnstile_token | string | nie | |
promo_code | string | nie | ; Kod promocyjny rejestracji |
invitation_code | string | nie | ; Kod zaproszenia |
{
"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 oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: RegisterRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: User, AuthResponse. Pola i typy — na stronach „Schematy danych”.
Jeśli możliwych jest kilka wariantów odpowiedzi, ich pola są wymienione w osobnych schematach; nie należy łączyć ich w jeden obiekt.
Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/reset-password — Reset hasła
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Limit częstotliwości: 10 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/reset-passwordPola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
email | string | tak | required,email |
token | string | tak | required |
new_password | string | tak | required,min=6 |
{
"email": "PLACEHOLDER_EMAIL (string)",
"token": "PLACEHOLDER_TOKEN (string)",
"new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: ResetPasswordRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: ResetPasswordResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/revoke-all-sessions — Unieważnienie wszystkich sesji
Dostęp: Token panelu użytkownika
/api/v1/auth/revoke-all-sessionsTreść żądania nie jest wymagana.
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: RevokeAllSessionsResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Cechy szczególne: Wszystkie dane osobowe i obiekty są ograniczone do podmiotu JWT.
Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/send-verify-code — Wysłanie kodu potwierdzającego
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Limit częstotliwości: 5 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/send-verify-codePola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
email | string | tak | required,email |
turnstile_token | string | nie |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: SendVerifyCodeRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: SendVerifyCodeResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)",
"countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}
}Uwagi: operacja zmienia stan lub kontynuuje jednorazową autoryzację; przykład opisuje kontrakt i nie jest wykonywany.
POST /api/v1/auth/validate-invitation-code — Weryfikacja zaproszenia
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 10 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/validate-invitation-codePola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
code | string | tak | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: ValidateInvitationCodeRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: ValidateInvitationCodeResponse. Pola i typy — na stronach „Schematy danych”.
{
"code": 0,
"message": "success",
"data": {
"valid": "PLACEHOLDER_VALID (boolean)",
"error_code": "PLACEHOLDER_ERROR_CODE (string)"
}
}Cechy: Metoda sprawdza zaproszenie i nie zużywa kodu; przykład opisuje kontrakt API i nie jest wykonywany.
POST /api/v1/auth/validate-promo-code — Weryfikacja kodu promocyjnego
Dostęp: Bez logowania; dodatkowe warunki podano przy metodzie
Dostępność funkcji i dodatkowe warunki dostępu są sprawdzane podczas wykonania żądania.
Limit częstotliwości: 10 żądań w ciągu 60 sekund z jednego adresu.
/api/v1/auth/validate-promo-codePola JSON / formularza
| Pole | Typ | Wymagane | Walidacja / opis |
|---|---|---|---|
code | string | tak | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER oznacza Twoje dane wejściowe i ich typ. Zastąp wartości i pozostaw tylko potrzebne pola opcjonalne; znaczników tekstowych nie wysyła się zamiast liczb, wartości boolean, obiektów lub tablic.
Schemat żądania: ValidatePromoCodeRequest
Odpowiedź
Odpowiedź JSON zawiera code, message i data. Zawartość data opisano w schematach poniżej.
Schematy danych odpowiedzi: ValidatePromoCodeResponse. Pola i typy — na stronach „Schematy danych”.
{
"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)"
}
}Cechy: Metoda sprawdza kod promocyjny i nie nalicza bonusu; przykład opisuje kontrakt API i nie jest wykonywany.
Logowanie i sesje · 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