Anmeldung und Sitzungen
MarkdownMethoden, Anfragefelder und Antworten.
Vollständiger Leitfaden
Dieser Abschnitt enthält 14 Methoden. Öffnen Sie eine Methode, um Zugriffsbedingungen, Anfragefelder und Antwort zu sehen.
| Methode und Pfad | Beschreibung | Zugriff |
|---|---|---|
POST /api/v1/auth/forgot-password | Passwortzurücksetzung anfordern | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/login | Anmeldung mit E-Mail-Adresse und Passwort | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/login/2fa | Anmeldung mit TOTP abschließen | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/logout | Abmelden und Refresh-Token widerrufen | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
GET /api/v1/auth/me | Aktueller Nutzer, Guthaben und Limits | Token des Kundenbereichs |
POST /api/v1/auth/passkey/login/begin | Passkey-Anmeldung starten | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/passkey/login/finish | Passkey-Anmeldung abschließen | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/refresh | Tokens erneuern | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/register | Registrierung | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/reset-password | Passwort zurücksetzen | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/revoke-all-sessions | Alle Sitzungen widerrufen | Token des Kundenbereichs |
POST /api/v1/auth/send-verify-code | Bestätigungscode senden | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/validate-invitation-code | Einladung prüfen | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/validate-promo-code | Aktionscode prüfen | Ohne Anmeldung; weitere Bedingungen stehen bei der Methode. |
POST /api/v1/auth/forgot-password — Passwortzurücksetzung anfordern
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Ratenlimit: 5 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/forgot-passwordJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
email | string | ja | required,email |
turnstile_token | string | nein |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: ForgotPasswordRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: ForgotPasswordResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/login — Anmeldung mit E-Mail-Adresse und Passwort
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 20 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/loginJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
email | string | ja | required,email |
password | string | ja | required |
turnstile_token | string | nein |
{
"email": "PLACEHOLDER_EMAIL (string)",
"password": "PLACEHOLDER_PASSWORD (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: LoginRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: TotpLoginResponse, User, AuthResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
Wenn mehrere Antwortvarianten möglich sind, stehen ihre Felder in getrennten Schemata. Führen Sie sie nicht zu einem Objekt zusammen.
Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/login/2fa — Anmeldung mit TOTP abschließen
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 20 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/login/2faJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
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 kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: Login2FARequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: User, AuthResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
Wenn mehrere Antwortvarianten möglich sind, stehen ihre Felder in getrennten Schemata. Führen Sie sie nicht zu einem Objekt zusammen.
Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/logout — Abmelden und Refresh-Token widerrufen
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
/api/v1/auth/logoutJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
refresh_token | string | nein | ; Optional: das angegebene Refresh-Token widerrufen |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: LogoutRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: LogoutResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
GET /api/v1/auth/me — Aktueller Nutzer, Guthaben und Limits
Zugriff: Token des Kundenbereichs
/api/v1/auth/mecurl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
-H "Authorization: Bearer $TOKEN"Ein Anfrageinhalt ist nicht erforderlich. Übermitteln Sie die oben genannten Parameter in der URL.
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: User, UserProfileResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"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)"
}
}Besonderheit: Alle personenbezogenen Daten und Objekte sind auf das JWT-Subjekt beschränkt.
Besonderheit: Ausgabenlimits der Schlüssel (quota, quota_used) stehen in der Schlüsselantwort, nicht im Profil. frozen_balance ist der reservierte Betrag und darf nicht als freies Guthaben betrachtet werden.
POST /api/v1/auth/passkey/login/begin — Passkey-Anmeldung starten
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 20 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/passkey/login/beginJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
turnstile_token | string | nein |
{
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: PasskeyBeginLoginRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: PasskeyOptionsResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"options": "PLACEHOLDER_OPTIONS (any)"
}
}Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
Besonderheit: credential stammt aus navigator.credentials, session_token aus begin. Der Finish-Anfrageinhalt ist auf <=65536 Byte begrenzt; Registrierung und Löschung erfordern ein Passwort.
POST /api/v1/auth/passkey/login/finish — Passkey-Anmeldung abschließen
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 20 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/passkey/login/finishJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
session_token | string | ja | required |
name | string | nein | |
credential | object | ja | required |
{
"session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
"name": "PLACEHOLDER_NAME (string)",
"credential": "PLACEHOLDER_CREDENTIAL (object)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: PasskeyFinishRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: User, AuthResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
Wenn mehrere Antwortvarianten möglich sind, stehen ihre Felder in getrennten Schemata. Führen Sie sie nicht zu einem Objekt zusammen.
Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
Besonderheit: credential stammt aus navigator.credentials, session_token aus begin. Der Finish-Anfrageinhalt ist auf <=65536 Byte begrenzt; Registrierung und Löschung erfordern ein Passwort.
POST /api/v1/auth/refresh — Tokens erneuern
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 30 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/refreshJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
refresh_token | string | ja | required |
{
"refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: RefreshTokenRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: RefreshTokenResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"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)"
}
}Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/register — Registrierung
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Ratenlimit: 5 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/registerJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
email | string | ja | required,email |
password | string | ja | required,min=6 |
verify_code | string | nein | |
turnstile_token | string | nein | |
promo_code | string | nein | ; Aktionscode für die Registrierung |
invitation_code | string | nein | ; Einladungscode |
{
"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 kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: RegisterRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: User, AuthResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
Wenn mehrere Antwortvarianten möglich sind, stehen ihre Felder in getrennten Schemata. Führen Sie sie nicht zu einem Objekt zusammen.
Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/reset-password — Passwort zurücksetzen
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Ratenlimit: 10 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/reset-passwordJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
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 kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: ResetPasswordRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: ResetPasswordResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/revoke-all-sessions — Alle Sitzungen widerrufen
Zugriff: Token des Kundenbereichs
/api/v1/auth/revoke-all-sessionsEin Anfrageinhalt ist nicht erforderlich.
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: RevokeAllSessionsResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)"
}
}Besonderheit: Alle personenbezogenen Daten und Objekte sind auf das JWT-Subjekt beschränkt.
Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/send-verify-code — Bestätigungscode senden
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Ratenlimit: 5 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/send-verify-codeJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
email | string | ja | required,email |
turnstile_token | string | nein |
{
"email": "PLACEHOLDER_EMAIL (string)",
"turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: SendVerifyCodeRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: SendVerifyCodeResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"message": "PLACEHOLDER_MESSAGE (string)",
"countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}
}Besonderheit: Die Operation verändert den Zustand oder setzt eine einmalige Authentifizierung fort. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/validate-invitation-code — Einladung prüfen
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 10 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/validate-invitation-codeJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
code | string | ja | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: ValidateInvitationCodeRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: ValidateInvitationCodeResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"code": 0,
"message": "success",
"data": {
"valid": "PLACEHOLDER_VALID (boolean)",
"error_code": "PLACEHOLDER_ERROR_CODE (string)"
}
}Besonderheit: Die Methode prüft die Einladung und löst den Code nicht ein. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
POST /api/v1/auth/validate-promo-code — Aktionscode prüfen
Zugriff: Ohne Anmeldung; weitere Bedingungen stehen bei der Methode.
Die Verfügbarkeit der Funktion und zusätzliche Zugriffsbedingungen werden bei der Ausführung der Anfrage geprüft.
Ratenlimit: 10 Anfragen in 60 Sekunden von einer Adresse.
/api/v1/auth/validate-promo-codeJSON- / Formularfelder
| Das Feld | Typ | Erforderlich | Prüfung / Beschreibung |
|---|---|---|---|
code | string | ja | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER kennzeichnet Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder bei. Zeichenfolgenmarker werden nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet.
Anfrageschema: ValidatePromoCodeRequest
Antwort
Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den folgenden Schemata beschrieben.
Datenschemata der Antwort: ValidatePromoCodeResponse. Felder und Typen stehen auf den Seiten „Datenschemata“.
{
"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)"
}
}Besonderheit: Die Methode prüft den Aktionscode und schreibt keinen Bonus gut. Das Beispiel beschreibt den API-Kontrakt und wird nicht ausgeführt.
Anmeldung und Sitzungen · 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