dokumentasi
API dasbor

Profil dan keamanan

Markdown

Metode, kolom permintaan, dan respons.

Panduan lengkap

Bagian ini berisi 6 metode. Buka metode untuk melihat ketentuan akses, kolom permintaan, dan respons.

Metode dan jalurDeskripsiAkses
PUT /api/v1/userPerubahan profilToken dasbor
GET /api/v1/user/passkeysDaftar passkeyToken dasbor
PUT /api/v1/user/passwordPerubahan kata sandiToken dasbor
GET /api/v1/user/profileProfil, saldo, dan keterkaitan akunToken dasbor
GET /api/v1/user/totp/statusStatus 2FA (TOTP)Token dasbor
GET /api/v1/user/totp/verification-methodMetode verifikasi TOTPToken dasbor
PUT /api/v1/user — Perubahan profil

Akses: Token dasbor

PUT/api/v1/user

Kolom JSON / formulir

KolomJenisWajibValidasi / deskripsi
usernamestringtidak; dapat berupa null
avatar_urlstringtidak; dapat berupa null
balance_notify_enabledbooleantidak; dapat berupa null
balance_notify_thresholdnumbertidak; dapat berupa null
Templat isi permintaan
{
  "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 mewakili input Anda dan tipenya. Ganti nilai-nilainya dan sisakan hanya kolom opsional yang diperlukan; jangan kirim penanda string sebagai pengganti angka, boolean, objek, atau array.

Skema permintaan: UpdateProfileRequest

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema data respons: User, UserProfileResponse. Kolom dan tipe dijelaskan di halaman “Skema data”.

Skema respons, nilai hanya contoh
{
  "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)"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: Operasi mengubah keadaan atau melanjutkan autentikasi sekali pakai; contoh menjelaskan kontrak dan tidak dijalankan.

Catatan khusus: Batas pengeluaran kunci (quota, quota_used) terdapat dalam respons kunci, bukan profil. frozen_balance adalah jumlah yang ditahan dan tidak boleh dianggap sebagai saldo bebas.

GET /api/v1/user/passkeys — Daftar passkey

Akses: Token dasbor

GET/api/v1/user/passkeys
Pembacaan; ID diambil dari respons Anda sebelumnya
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Isi permintaan tidak diperlukan. Kirim parameter di atas dalam URL.

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema data respons: PasskeyCredentialSummary. Kolom dan tipe dijelaskan di halaman “Skema data”.

Skema respons, nilai hanya contoh
{
  "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)"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: credential diperoleh dari navigator.credentials; session_token dari begin. Isi finish <=65536 byte; pendaftaran dan penghapusan memerlukan kata sandi.

PUT /api/v1/user/password — Perubahan kata sandi

Akses: Token dasbor

PUT/api/v1/user/password

Kolom JSON / formulir

KolomJenisWajibValidasi / deskripsi
old_passwordstringyarequired
new_passwordstringyarequired,min=6
Templat isi permintaan
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER mewakili input Anda dan tipenya. Ganti nilai-nilainya dan sisakan hanya kolom opsional yang diperlukan; jangan kirim penanda string sebagai pengganti angka, boolean, objek, atau array.

Skema permintaan: ChangePasswordRequest

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema respons, nilai hanya contoh
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: Operasi mengubah keadaan atau melanjutkan autentikasi sekali pakai; contoh menjelaskan kontrak dan tidak dijalankan.

GET /api/v1/user/profile — Profil, saldo, dan keterkaitan akun

Akses: Token dasbor

GET/api/v1/user/profile
Pembacaan; ID diambil dari respons Anda sebelumnya
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Isi permintaan tidak diperlukan. Kirim parameter di atas dalam URL.

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema data respons: User, UserProfileResponse. Kolom dan tipe dijelaskan di halaman “Skema data”.

Skema respons, nilai hanya contoh
{
  "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)"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: Batas pengeluaran kunci (quota, quota_used) terdapat dalam respons kunci, bukan profil. frozen_balance adalah jumlah yang ditahan dan tidak boleh dianggap sebagai saldo bebas.

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

Akses: Token dasbor

GET/api/v1/user/totp/status
Pembacaan; ID diambil dari respons Anda sebelumnya
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Isi permintaan tidak diperlukan. Kirim parameter di atas dalam URL.

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema data respons: TotpStatusResponse. Kolom dan tipe dijelaskan di halaman “Skema data”.

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

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: secret dan setup_token bersifat rahasia; verifikasi bergantung pada pengaturan TOTP dan pengguna.

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

Akses: Token dasbor

GET/api/v1/user/totp/verification-method
Pembacaan; ID diambil dari respons Anda sebelumnya
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Isi permintaan tidak diperlukan. Kirim parameter di atas dalam URL.

Respons

Respons JSON berisi code, message, dan data. Isi data dijelaskan dalam skema di bawah.

Skema respons, nilai hanya contoh
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

Catatan khusus: Semua data pribadi dan objek dibatasi pada subjek JWT.

Catatan khusus: secret dan setup_token bersifat rahasia; verifikasi bergantung pada pengaturan TOTP dan pengguna.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
Masih ada pertanyaan? Kirim Request ID dan penjelasannya — kami akan membantu.Hubungi dukungan