Kirjautuminen ja istunnot

Metodit, pyyntöjen kentät ja vastaukset.

Koko opas

Osiossa on 14 metodia. Avaa metodi nähdäksesi käyttöoikeusehdot, pyynnön kentät ja vastauksen.

Metodi ja polku	Kuvaus	Käyttöoikeus
`POST /api/v1/auth/forgot-password`	Salasanan palautuspyyntö	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/login`	Kirjautuminen sähköpostilla ja salasanalla	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/login/2fa`	TOTP-kirjautumisen viimeistely	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/logout`	Uloskirjautuminen ja päivitystokenin mitätöinti	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`GET /api/v1/auth/me`	Nykyinen käyttäjä, saldo ja rajoitukset	Hallintapaneelin token
`POST /api/v1/auth/passkey/login/begin`	Pääsyavaimella kirjautumisen aloitus	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/passkey/login/finish`	Pääsyavaimella kirjautumisen viimeistely	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/refresh`	Tokenien uusiminen	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/register`	Rekisteröidy	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/reset-password`	Salasanan palautus	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/revoke-all-sessions`	Kaikkien istuntojen mitätöinti	Hallintapaneelin token
`POST /api/v1/auth/send-verify-code`	Vahvistuskoodin lähettäminen	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/validate-invitation-code`	Kutsun tarkistus	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla
`POST /api/v1/auth/validate-promo-code`	Kampanjakoodin tarkistus	Ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

POST /api/v1/auth/forgot-password — Salasanan palautuspyyntö

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Pyyntötiheyden raja: 5 pyyntöä 60 sekunnissa yhdestä osoitteesta.

POST/api/v1/auth/forgot-password

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`email`	`string`	kyllä	required,email
`turnstile_token`	`string`	ei

Pyynnön rungon mallipohja

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

PLACEHOLDER merkitsee omaa syötettäsi ja sen tyyppiä. Korvaa arvot ja säilytä vain tarvitsemasi valinnaiset kentät; merkkijonomerkkejä ei lähetetä lukujen, boolean-arvojen, objektien tai taulukoiden sijaan.

Pyynnön skeema: ForgotPasswordRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: ForgotPasswordResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/login — Kirjautuminen sähköpostilla ja salasanalla

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 20 pyyntöä 60 sekunnissa yhdestä osoitteesta.

POST/api/v1/auth/login

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`email`	`string`	kyllä	required,email
`password`	`string`	kyllä	required
`turnstile_token`	`string`	ei

Pyynnön rungon mallipohja

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

Pyynnön skeema: LoginRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: TotpLoginResponse, User, AuthResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Jos mahdollisia vastausvaihtoehtoja on useita, niiden kentät luetellaan erillisissä skeemoissa; niitä ei tule yhdistää yhdeksi objektiksi.

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/login/2fa — TOTP-kirjautumisen viimeistely

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 20 pyyntöä 60 sekunnissa yhdestä osoitteesta.

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

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`temp_token`	`string`	kyllä	required
`totp_code`	`string`	kyllä	required,len=6

Pyynnön rungon mallipohja

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

Pyynnön skeema: Login2FARequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: User, AuthResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Jos mahdollisia vastausvaihtoehtoja on useita, niiden kentät luetellaan erillisissä skeemoissa; niitä ei tule yhdistää yhdeksi objektiksi.

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/logout — Uloskirjautuminen ja päivitystokenin mitätöinti

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

POST/api/v1/auth/logout

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`refresh_token`	`string`	ei	; Valinnainen: mitätöi annettu päivitystoken

Pyynnön rungon mallipohja

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

Pyynnön skeema: LogoutRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: LogoutResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

GET /api/v1/auth/me — Nykyinen käyttäjä, saldo ja rajoitukset

Käyttöoikeus: hallintapaneelin token

GET/api/v1/auth/me

Lukutoiminto; ID otetaan aiemmasta vastauksestasi

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

Pyynnön runkoa ei tarvita. Lähetä yllä luetellut parametrit URLissa.

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: User, UserProfileResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin.

Huomioitavaa: Avainten kulutusrajat (quota, quota_used) saapuvat avainten vastauksessa, eivät profiilissa. frozen_balance on varattu summa, eikä sitä pidä laskea vapaaksi saldoksi.

POST /api/v1/auth/passkey/login/begin — Pääsyavaimella kirjautumisen aloitus

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 20 pyyntöä 60 sekunnissa yhdestä osoitteesta.

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

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`turnstile_token`	`string`	ei

Pyynnön rungon mallipohja

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

Pyynnön skeema: PasskeyBeginLoginRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: PasskeyOptionsResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

Huomioitavaa: credential saadaan navigator.credentials-rajapinnasta; session_token begin-vastauksesta. Finish-pyynnön runko <=65536 tavua; rekisteröinti ja poistaminen vaativat salasanan.

POST /api/v1/auth/passkey/login/finish — Pääsyavaimella kirjautumisen viimeistely

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 20 pyyntöä 60 sekunnissa yhdestä osoitteesta.

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

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`session_token`	`string`	kyllä	required
`name`	`string`	ei
`credential`	`object`	kyllä	required

Pyynnön rungon mallipohja

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

Pyynnön skeema: PasskeyFinishRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: User, AuthResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Jos mahdollisia vastausvaihtoehtoja on useita, niiden kentät luetellaan erillisissä skeemoissa; niitä ei tule yhdistää yhdeksi objektiksi.

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

Huomioitavaa: credential saadaan navigator.credentials-rajapinnasta; session_token begin-vastauksesta. Finish-pyynnön runko <=65536 tavua; rekisteröinti ja poistaminen vaativat salasanan.

POST /api/v1/auth/refresh — Tokenien uusiminen

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 30 pyyntöä 60 sekunnissa yhdestä osoitteesta.

POST/api/v1/auth/refresh

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`refresh_token`	`string`	kyllä	required

Pyynnön rungon mallipohja

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

Pyynnön skeema: RefreshTokenRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: RefreshTokenResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/register — Rekisteröityminen

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Pyyntötiheyden raja: 5 pyyntöä 60 sekunnissa yhdestä osoitteesta.

POST/api/v1/auth/register

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`email`	`string`	kyllä	required,email
`password`	`string`	kyllä	required,min=6
`verify_code`	`string`	ei
`turnstile_token`	`string`	ei
`promo_code`	`string`	ei	; Rekisteröinnin kampanjakoodi
`invitation_code`	`string`	ei	; Kutsukoodi

Pyynnön rungon mallipohja

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

Pyynnön skeema: RegisterRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: User, AuthResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Jos mahdollisia vastausvaihtoehtoja on useita, niiden kentät luetellaan erillisissä skeemoissa; niitä ei tule yhdistää yhdeksi objektiksi.

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/reset-password — Salasanan palautus

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Pyyntötiheyden raja: 10 pyyntöä 60 sekunnissa yhdestä osoitteesta.

POST/api/v1/auth/reset-password

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`email`	`string`	kyllä	required,email
`token`	`string`	kyllä	required
`new_password`	`string`	kyllä	required,min=6

Pyynnön rungon mallipohja

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

Pyynnön skeema: ResetPasswordRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: ResetPasswordResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/revoke-all-sessions — Kaikkien istuntojen mitätöinti

Käyttöoikeus: hallintapaneelin token

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

Pyynnön runkoa ei tarvita.

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: RevokeAllSessionsResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin.

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/send-verify-code — Vahvistuskoodin lähettäminen

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Pyyntötiheyden raja: 5 pyyntöä 60 sekunnissa yhdestä osoitteesta.

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

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`email`	`string`	kyllä	required,email
`turnstile_token`	`string`	ei

Pyynnön rungon mallipohja

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

Pyynnön skeema: SendVerifyCodeRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: SendVerifyCodeResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

POST /api/v1/auth/validate-invitation-code — Kutsun tarkistus

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 10 pyyntöä 60 sekunnissa yhdestä osoitteesta.

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

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`code`	`string`	kyllä	required

Pyynnön rungon mallipohja

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

Pyynnön skeema: ValidateInvitationCodeRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: ValidateInvitationCodeResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Metodi tarkistaa kutsun eikä kuluta koodia; esimerkki kuvaa rajapintasopimuksen eikä sitä suoriteta.

POST /api/v1/auth/validate-promo-code — Kampanjakoodin tarkistus

Käyttöoikeus: ilman kirjautumista; lisäehdot ilmoitetaan metodin kohdalla

Toiminnon saatavuus ja käyttöoikeuden lisäehdot tarkistetaan pyyntöä suoritettaessa.

Pyyntötiheyden raja: 10 pyyntöä 60 sekunnissa yhdestä osoitteesta.

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

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`code`	`string`	kyllä	required

Pyynnön rungon mallipohja

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

Pyynnön skeema: ValidatePromoCodeRequest

Vastaus

JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa.

Vastauksen tietoskeemat: ValidatePromoCodeResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

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

Huomioitavaa: Metodi tarkistaa kampanjakoodin eikä myönnä bonusta; esimerkki kuvaa rajapintasopimuksen eikä sitä suoriteta.

Kirjautuminen ja istunnot · 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

Onko vielä kysyttävää? Lähetä Request ID ja kuvaus — autamme selvittämään asian.Ota yhteyttä tukeen