Profil in varnost

Metode, polja zahtev in odgovori.

Celoten vodnik

V razdelku je 6 metod. Odprite metodo, da si ogledate pogoje dostopa, polja zahteve in odgovor.

Metoda in pot	Opis	Dostop
`PUT /api/v1/user`	Sprememba profila	Žeton nadzorne plošče
`GET /api/v1/user/passkeys`	Seznam ključev za dostop	Žeton nadzorne plošče
`PUT /api/v1/user/password`	Sprememba gesla	Žeton nadzorne plošče
`GET /api/v1/user/profile`	Profil, stanje in povezave	Žeton nadzorne plošče
`GET /api/v1/user/totp/status`	Stanje 2FA (TOTP)	Žeton nadzorne plošče
`GET /api/v1/user/totp/verification-method`	Način preverjanja TOTP	Žeton nadzorne plošče

PUT /api/v1/user – Sprememba profila

Dostop: Žeton nadzorne plošče

PUT/api/v1/user

Polja JSON / obrazca

Polje	Vrsta	Obvezno	Preverjanje / opis
`username`	`string`	ne	; lahko je null
`avatar_url`	`string`	ne	; lahko je null
`balance_notify_enabled`	`boolean`	ne	; lahko je null
`balance_notify_threshold`	`number`	ne	; lahko je null

Predloga telesa zahteve

{
  "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 označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.

Shema zahteve: UpdateProfileRequest

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Podatkovne sheme odgovora: User, UserProfileResponse. Polja in vrste so na straneh »Podatkovne sheme«.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.

Posebnosti: Omejitve porabe ključev (quota, quota_used) so v odgovoru za ključe, ne v profilu. frozen_balance je rezervirani znesek, zato ga ne smete šteti za prosta sredstva.

GET /api/v1/user/passkeys – Seznam ključev za dostop

Dostop: Žeton nadzorne plošče

GET/api/v1/user/passkeys

Branje; ID je iz vašega prejšnjega odgovora

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

Telo zahteve ni potrebno. Zgoraj navedene parametre pošljite v URL.

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Podatkovne sheme odgovora: PasskeyCredentialSummary. Polja in vrste so na straneh »Podatkovne sheme«.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: credential je pridobljen iz navigator.credentials; session_token iz begin. Telo zahteve Finish <=65536 bajtov; registracija in odstranjevanje zahtevata geslo.

PUT /api/v1/user/password – Sprememba gesla

Dostop: Žeton nadzorne plošče

PUT/api/v1/user/password

Polja JSON / obrazca

Polje	Vrsta	Obvezno	Preverjanje / opis
`old_password`	`string`	da	required
`new_password`	`string`	da	required,min=6

Predloga telesa zahteve

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

PLACEHOLDER označuje vaš vnos in njegovo vrsto. Vrednosti zamenjajte in pustite le potrebna neobvezna polja; nizovnih oznak ne pošiljajte namesto števil, boolean, objektov ali polj.

Shema zahteve: ChangePasswordRequest

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: Operacija spremeni stanje ali nadaljuje enkratno avtentikacijo; primer opisuje pogodbo API-ja in se ne izvede.

GET /api/v1/user/profile – Profil, stanje in povezave

Dostop: Žeton nadzorne plošče

GET/api/v1/user/profile

Branje; ID je iz vašega prejšnjega odgovora

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

Telo zahteve ni potrebno. Zgoraj navedene parametre pošljite v URL.

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Podatkovne sheme odgovora: User, UserProfileResponse. Polja in vrste so na straneh »Podatkovne sheme«.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: Omejitve porabe ključev (quota, quota_used) so v odgovoru za ključe, ne v profilu. frozen_balance je rezervirani znesek, zato ga ne smete šteti za prosta sredstva.

GET /api/v1/user/totp/status – Stanje 2FA (TOTP)

Dostop: Žeton nadzorne plošče

GET/api/v1/user/totp/status

Branje; ID je iz vašega prejšnjega odgovora

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

Telo zahteve ni potrebno. Zgoraj navedene parametre pošljite v URL.

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Podatkovne sheme odgovora: TotpStatusResponse. Polja in vrste so na straneh »Podatkovne sheme«.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: secret in setup_token sta skrivna; preverjanje je odvisno od nastavitev TOTP in uporabnika.

GET /api/v1/user/totp/verification-method – Način preverjanja TOTP

Dostop: Žeton nadzorne plošče

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

Branje; ID je iz vašega prejšnjega odgovora

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

Telo zahteve ni potrebno. Zgoraj navedene parametre pošljite v URL.

Odgovor

Odgovor JSON vsebuje code, message in data. Vsebina data je opisana v spodnjih shemah.

Shema odgovora, vrednosti so ponazoritvene

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

Posebnosti: Vsi osebni podatki in objekti so omejeni na subjekt žetona JWT.

Posebnosti: secret in setup_token sta skrivna; preverjanje je odvisno od nastavitev TOTP in uporabnika.

TotpVerificationMethod

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

Imate še vprašanja? Pošljite Request ID in opis – pomagali vam bomo razjasniti težavo.Pišite podpori