Profiili ja turvallisuus

Metodit, pyyntöjen kentät ja vastaukset.

Koko opas

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

Metodi ja polku	Kuvaus	Käyttöoikeus
`PUT /api/v1/user`	Profiilin muuttaminen	Hallintapaneelin token
`GET /api/v1/user/passkeys`	Pääsyavainluettelo	Hallintapaneelin token
`PUT /api/v1/user/password`	Salasanan muuttaminen	Hallintapaneelin token
`GET /api/v1/user/profile`	Profiili, saldo ja kytkennät	Hallintapaneelin token
`GET /api/v1/user/totp/status`	2FA:n tila (TOTP)	Hallintapaneelin token
`GET /api/v1/user/totp/verification-method`	TOTP:n tarkistusmenetelmä	Hallintapaneelin token

PUT /api/v1/user — Profiilin muuttaminen

Käyttöoikeus: hallintapaneelin token

PUT/api/v1/user

JSON- / lomakekentät

Kenttä	Tyyppi	Pakollinen	Tarkistus / kuvaus
`username`	`string`	ei	; voi olla null
`avatar_url`	`string`	ei	; voi olla null
`balance_notify_enabled`	`boolean`	ei	; voi olla null
`balance_notify_threshold`	`number`	ei	; voi olla null

Pyynnön rungon mallipohja

{
  "username": "PLACEHOLDER_USERNAME (string)",
  "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
  "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
  "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)"
}

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: UpdateProfileRequest

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: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta.

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

GET /api/v1/user/passkeys — Pääsyavainluettelo

Käyttöoikeus: hallintapaneelin token

GET/api/v1/user/passkeys

Lukutoiminto; ID otetaan aiemmasta vastauksestasi

curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -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: PasskeyCredentialSummary. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "name": "PLACEHOLDER_NAME (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "backup": "PLACEHOLDER_BACKUP (boolean)"
  }
}

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

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

PUT /api/v1/user/password — Salasanan muuttaminen

Käyttöoikeus: hallintapaneelin token

PUT/api/v1/user/password

JSON- / lomakekentät

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

Pyynnön rungon mallipohja

{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

Pyynnön skeema: ChangePasswordRequest

Vastaus

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

Vastauksen skeema, arvot ovat esimerkinomaisia

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

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.

GET /api/v1/user/profile — Profiili, saldo ja kytkennät

Käyttöoikeus: hallintapaneelin token

GET/api/v1/user/profile

Lukutoiminto; ID otetaan aiemmasta vastauksestasi

curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -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.

GET /api/v1/user/totp/status — 2FA:n tila (TOTP)

Käyttöoikeus: hallintapaneelin token

GET/api/v1/user/totp/status

Lukutoiminto; ID otetaan aiemmasta vastauksestasi

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -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: TotpStatusResponse. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta.

Vastauksen skeema, arvot ovat esimerkinomaisia

{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

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

Huomioitavaa: secret ja setup_token ovat salaisia; tarkistus riippuu TOTP-asetuksista ja käyttäjästä.

GET /api/v1/user/totp/verification-method — TOTP:n tarkistusmenetelmä

Käyttöoikeus: hallintapaneelin token

GET/api/v1/user/totp/verification-method

Lukutoiminto; ID otetaan aiemmasta vastauksestasi

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -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 skeema, arvot ovat esimerkinomaisia

{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

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

Huomioitavaa: secret ja setup_token ovat salaisia; tarkistus riippuu TOTP-asetuksista ja käyttäjästä.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}

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