Profil og sikkerhed

Metoder, anmodningsfelter og svar.

Komplet guide

Afsnittet indeholder 6 metoder. Åbn en metode for at se adgangsbetingelser, anmodningsfelter og svar.

Metode og sti	Beskrivelse	Adgang
`PUT /api/v1/user`	Ændring af profil	Kontrolpanelets token
`GET /api/v1/user/passkeys`	Liste over passkeys	Kontrolpanelets token
`PUT /api/v1/user/password`	Ændring af adgangskode	Kontrolpanelets token
`GET /api/v1/user/profile`	Profil, saldo og tilknytninger	Kontrolpanelets token
`GET /api/v1/user/totp/status`	2FA-status (TOTP)	Kontrolpanelets token
`GET /api/v1/user/totp/verification-method`	Metode til TOTP-verifikation	Kontrolpanelets token

PUT /api/v1/user — Ændring af profil

Adgang: kontrolpanelets token

PUT/api/v1/user

JSON- / formularfelter

Feltet	Type	Obligatorisk	Validering / beskrivelse
`username`	`string`	nej	; kan være null
`avatar_url`	`string`	nej	; kan være null
`balance_notify_enabled`	`boolean`	nej	; kan være null
`balance_notify_threshold`	`number`	nej	; kan være null

Skabelon til anmodningens indhold

{
  "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 angiver dit input og dets type. Erstat værdierne, og behold kun de valgfrie felter, du har brug for; strengmarkører sendes ikke i stedet for tal, boolean, objekter eller lister.

Anmodningsskema: UpdateProfileRequest

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarenes dataskemaer: User, UserProfileResponse. Felter og typer findes på siderne »Dataskemaer«.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: Handlingen ændrer tilstanden eller fortsætter en engangsautorisation; eksemplet beskriver kontrakten og udføres ikke.

Bemærk: Nøglernes forbrugsgrænser (quota, quota_used) returneres i nøglesvaret, ikke i profilen. frozen_balance er det reserverede beløb og må ikke betragtes som ledig saldo.

GET /api/v1/user/passkeys — Liste over passkeys

Adgang: kontrolpanelets token

GET/api/v1/user/passkeys

Læsning; ID hentes fra dit tidligere svar

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

Anmodningens indhold er ikke nødvendigt. Send de ovenstående parametre i URL'en.

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarenes dataskemaer: PasskeyCredentialSummary. Felter og typer findes på siderne »Dataskemaer«.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: credential hentes fra navigator.credentials; session_token fra begin. Indholdet i finish-anmodningen <=65536 bytes; registrering og sletning kræver adgangskode.

PUT /api/v1/user/password — Ændring af adgangskode

Adgang: kontrolpanelets token

PUT/api/v1/user/password

JSON- / formularfelter

Feltet	Type	Obligatorisk	Validering / beskrivelse
`old_password`	`string`	ja	required
`new_password`	`string`	ja	required,min=6

Skabelon til anmodningens indhold

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

PLACEHOLDER angiver dit input og dets type. Erstat værdierne, og behold kun de valgfrie felter, du har brug for; strengmarkører sendes ikke i stedet for tal, boolean, objekter eller lister.

Anmodningsskema: ChangePasswordRequest

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: Handlingen ændrer tilstanden eller fortsætter en engangsautorisation; eksemplet beskriver kontrakten og udføres ikke.

GET /api/v1/user/profile — Profil, saldo og tilknytninger

Adgang: kontrolpanelets token

GET/api/v1/user/profile

Læsning; ID hentes fra dit tidligere svar

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

Anmodningens indhold er ikke nødvendigt. Send de ovenstående parametre i URL'en.

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarenes dataskemaer: User, UserProfileResponse. Felter og typer findes på siderne »Dataskemaer«.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: Nøglernes forbrugsgrænser (quota, quota_used) returneres i nøglesvaret, ikke i profilen. frozen_balance er det reserverede beløb og må ikke betragtes som ledig saldo.

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

Adgang: kontrolpanelets token

GET/api/v1/user/totp/status

Læsning; ID hentes fra dit tidligere svar

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

Anmodningens indhold er ikke nødvendigt. Send de ovenstående parametre i URL'en.

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarenes dataskemaer: TotpStatusResponse. Felter og typer findes på siderne »Dataskemaer«.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: secret og setup_token er hemmelige; kontrollen afhænger af TOTP-indstillingerne og brugeren.

GET /api/v1/user/totp/verification-method — Metode til TOTP-verifikation

Adgang: kontrolpanelets token

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

Læsning; ID hentes fra dit tidligere svar

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

Anmodningens indhold er ikke nødvendigt. Send de ovenstående parametre i URL'en.

Svar

JSON-svaret indeholder code, message og data. Indholdet af data beskrives i skemaerne nedenfor.

Svarskema med illustrative værdier

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

Bemærk: Alle personoplysninger og objekter er afgrænset til JWT-subjektet.

Bemærk: secret og setup_token er hemmelige; kontrollen afhænger af TOTP-indstillingerne og brugeren.

TotpVerificationMethod

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

Har du stadig spørgsmål? Send Request ID og en beskrivelse — så hjælper vi med at finde ud af det.Kontakt support