Fiók-API

Profil és biztonság

Metódusok, kérésmezők és válaszok.

Teljes útmutató

Ebben a részben 6 metódus található. Nyissa meg a metódust a hozzáférési feltételek, a kérésmezők és a válasz megtekintéséhez.

Metódus és útvonal	Leírás	Hozzáférés
`PUT /api/v1/user`	Profil módosítása	Fióktoken
`GET /api/v1/user/passkeys`	Passkey-k listája	Fióktoken
`PUT /api/v1/user/password`	Jelszó módosítása	Fióktoken
`GET /api/v1/user/profile`	Profil, egyenleg és összekapcsolások	Fióktoken
`GET /api/v1/user/totp/status`	2FA állapota (TOTP)	Fióktoken
`GET /api/v1/user/totp/verification-method`	A TOTP ellenőrzési módja	Fióktoken

PUT /api/v1/user — Profil módosítása

Hozzáférés: fióktoken

PUT/api/v1/user

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`username`	`string`	nem	; null is lehet
`avatar_url`	`string`	nem	; null is lehet
`balance_notify_enabled`	`boolean`	nem	; null is lehet
`balance_notify_threshold`	`number`	nem	; null is lehet

Kéréstörzs-sablon

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

A PLACEHOLDER az Ön által megadandó értéket és annak típusát jelöli. Cserélje ki az értékeket, és csak a szükséges nem kötelező mezőket tartsa meg; karakterlánc-jelölők nem küldhetők számok, boolean értékek, objektumok vagy tömbök helyett.

A kérés sémája: UpdateProfileRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: User, UserProfileResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

Sajátosságok: a kulcsok költési korlátai (quota, quota_used) a kulcsok válaszában érkeznek, nem a profilban. A frozen_balance zárolt összeg, nem tekinthető szabad egyenlegnek.

GET /api/v1/user/passkeys — Passkey-k listája

Hozzáférés: fióktoken

GET/api/v1/user/passkeys

Olvasás; az azonosító a korábbi válaszából származik

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

A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: PasskeyCredentialSummary. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a credential a navigator.credentials eredménye; a session_token a begin válaszából származik. Finish body <=65536 bájt; a regisztrációhoz és törléshez jelszó szükséges.

PUT /api/v1/user/password — Jelszó módosítása

Hozzáférés: fióktoken

PUT/api/v1/user/password

JSON- / űrlapmezők

Mező:	Típus	Kötelező	Ellenőrzés / leírás
`old_password`	`string`	igen	required
`new_password`	`string`	igen	required,min=6

Kéréstörzs-sablon

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

A kérés sémája: ChangePasswordRequest

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra.

GET /api/v1/user/profile — Profil, egyenleg és összekapcsolások

Hozzáférés: fióktoken

GET/api/v1/user/profile

Olvasás; az azonosító a korábbi válaszából származik

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

A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: User, UserProfileResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a kulcsok költési korlátai (quota, quota_used) a kulcsok válaszában érkeznek, nem a profilban. A frozen_balance zárolt összeg, nem tekinthető szabad egyenlegnek.

GET /api/v1/user/totp/status — 2FA állapota (TOTP)

Hozzáférés: fióktoken

GET/api/v1/user/totp/status

Olvasás; az azonosító a korábbi válaszából származik

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

A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

A válasz adatsémái: TotpStatusResponse. A mezők és típusok az „Adatsémák” oldalain találhatók.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a secret és setup_token titkos; az ellenőrzés a TOTP és a felhasználó beállításaitól függ.

GET /api/v1/user/totp/verification-method — A TOTP ellenőrzési módja

Hozzáférés: fióktoken

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

Olvasás; az azonosító a korábbi válaszából származik

curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg.

Válasz

A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le.

Válaszséma, szemléltető értékekkel

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

Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött.

Sajátosságok: a secret és setup_token titkos; az ellenőrzés a TOTP és a felhasználó beállításaitól függ.

TotpVerificationMethod

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

Maradt kérdése? Küldje el a Request ID-t és a probléma leírását — segítünk tisztázni.Írjon a támogatásnak