Profilis ir saugumas

Metodai, užklausų laukai ir atsakymai.

Visas vadovas

Skiltyje yra 6 metodai. Atverkite metodą, kad peržiūrėtumėte prieigos sąlygas, užklausos laukus ir atsakymą.

Metodas ir kelias	Aprašymas	Prieiga
`PUT /api/v1/user`	Profilio keitimas	Paskyros žetonas
`GET /api/v1/user/passkeys`	passkey sąrašas	Paskyros žetonas
`PUT /api/v1/user/password`	Slaptažodžio keitimas	Paskyros žetonas
`GET /api/v1/user/profile`	Profilis, balansas ir susiejimai	Paskyros žetonas
`GET /api/v1/user/totp/status`	2FA (TOTP) būsena	Paskyros žetonas
`GET /api/v1/user/totp/verification-method`	TOTP patikros būdas	Paskyros žetonas

PUT /api/v1/user — Profilio keitimas

Prieiga: paskyros žetonas

PUT/api/v1/user

JSON / formos laukai

Laukas	Tipas	Privaloma	Patikra / aprašymas
`username`	`string`	ne	; gali būti null
`avatar_url`	`string`	ne	; gali būti null
`balance_notify_enabled`	`boolean`	ne	; gali būti null
`balance_notify_threshold`	`number`	ne	; gali būti null

Užklausos turinio šablonas

{
  "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 žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: UpdateProfileRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: User, UserProfileResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

Ypatybės: raktų išlaidų limitai (quota, quota_used) pateikiami raktų atsakyme, o ne profilyje. frozen_balance — rezervuota suma, jos negalima laikyti laisvu balansu.

GET /api/v1/user/passkeys — passkey sąrašas

Prieiga: paskyros žetonas

GET/api/v1/user/passkeys

Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo

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

Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: PasskeyCredentialSummary. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: credential gautas iš navigator.credentials; session_token — iš begin. Finish body <=65536 baitų; registravimui ir šalinimui reikia slaptažodžio.

PUT /api/v1/user/password — Slaptažodžio keitimas

Prieiga: paskyros žetonas

PUT/api/v1/user/password

JSON / formos laukai

Laukas	Tipas	Privaloma	Patikra / aprašymas
`old_password`	`string`	taip	required
`new_password`	`string`	taip	required,min=6

Užklausos turinio šablonas

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

PLACEHOLDER žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų.

Užklausos schema: ChangePasswordRequest

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas.

GET /api/v1/user/profile — Profilis, balansas ir susiejimai

Prieiga: paskyros žetonas

GET/api/v1/user/profile

Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo

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

Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: User, UserProfileResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: raktų išlaidų limitai (quota, quota_used) pateikiami raktų atsakyme, o ne profilyje. frozen_balance — rezervuota suma, jos negalima laikyti laisvu balansu.

GET /api/v1/user/totp/status — 2FA (TOTP) būsena

Prieiga: paskyros žetonas

GET/api/v1/user/totp/status

Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo

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

Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo duomenų schemos: TotpStatusResponse. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: secret ir setup_token yra slapti; patikra priklauso nuo TOTP nustatymų ir vartotojo.

GET /api/v1/user/totp/verification-method — TOTP patikros būdas

Prieiga: paskyros žetonas

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

Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo

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

Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL.

Atsakymas

JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose.

Atsakymo schema, reikšmės pavyzdinės

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

Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu.

Ypatybės: secret ir setup_token yra slapti; patikra priklauso nuo TOTP nustatymų ir vartotojo.

TotpVerificationMethod

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

Liko klausimų? Atsiųskite Request ID ir aprašymą — padėsime išsiaiškinti.Rašyti pagalbos tarnybai