Perfil y seguridad
MarkdownMétodos, campos de las solicitudes y respuestas.
Guía completa
Esta sección contiene 6 métodos. Abre un método para consultar las condiciones de acceso, los campos de la solicitud y la respuesta.
| Método y ruta | Descripción | Acceso |
|---|---|---|
PUT /api/v1/user | Modificar el perfil | Token del panel de control |
GET /api/v1/user/passkeys | Lista de claves de acceso | Token del panel de control |
PUT /api/v1/user/password | Cambiar la contraseña | Token del panel de control |
GET /api/v1/user/profile | Perfil, saldo y vinculaciones | Token del panel de control |
GET /api/v1/user/totp/status | Estado de 2FA (TOTP) | Token del panel de control |
GET /api/v1/user/totp/verification-method | Método de verificación TOTP | Token del panel de control |
PUT /api/v1/user — Modificar el perfil
Acceso: token del panel de control
/api/v1/userCampos JSON / formulario
| El campo | Tipo | Obligatorio | Validación / descripción |
|---|---|---|---|
username | string | no | ; puede ser null |
avatar_url | string | no | ; puede ser null |
balance_notify_enabled | boolean | no | ; puede ser null |
balance_notify_threshold | number | no | ; puede ser null |
{
"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 representa tu entrada y su tipo. Sustituye los valores y conserva solo los campos opcionales que necesites; los marcadores de cadena no se envían en lugar de números, boolean, objetos o arrays.
Esquema de la solicitud: UpdateProfileRequest
Respuesta
La respuesta JSON contiene code, message y data. El contenido de data se describe en los esquemas siguientes.
Esquemas de datos de la respuesta: User, UserProfileResponse. Los campos y los tipos se describen en las páginas «Esquemas de datos».
{
"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)"
}
}Notas: todos los datos personales y los objetos quedan limitados al sujeto del JWT.
Notas: la operación cambia el estado o continúa una autorización de un solo uso; el ejemplo describe el contrato y no se ejecuta.
Notas: los límites de gasto de las claves (quota, quota_used) se devuelven en la respuesta de las claves, no en el perfil. frozen_balance es el importe reservado y no se puede considerar saldo disponible.
GET /api/v1/user/passkeys — Lista de claves de acceso
Acceso: token del panel de control
/api/v1/user/passkeyscurl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
-H "Authorization: Bearer $TOKEN"No se necesita cuerpo de solicitud. Envía los parámetros anteriores en la URL.
Respuesta
La respuesta JSON contiene code, message y data. El contenido de data se describe en los esquemas siguientes.
Esquemas de datos de la respuesta: PasskeyCredentialSummary. Los campos y los tipos se describen en las páginas «Esquemas de datos».
{
"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)"
}
}Notas: todos los datos personales y los objetos quedan limitados al sujeto del JWT.
Notas: credential se obtiene de navigator.credentials y session_token de begin. El cuerpo de finish debe ser <=65536 bytes; registrar y eliminar requieren contraseña.
PUT /api/v1/user/password — Cambiar la contraseña
Acceso: token del panel de control
/api/v1/user/passwordCampos JSON / formulario
| El campo | Tipo | Obligatorio | Validación / descripción |
|---|---|---|---|
old_password | string | sí | required |
new_password | string | sí | required,min=6 |
{
"old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
"new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}PLACEHOLDER representa tu entrada y su tipo. Sustituye los valores y conserva solo los campos opcionales que necesites; los marcadores de cadena no se envían en lugar de números, boolean, objetos o arrays.
Esquema de la solicitud: ChangePasswordRequest
Respuesta
La respuesta JSON contiene code, message y data. El contenido de data se describe en los esquemas siguientes.
{
"code": 0,
"message": "success",
"data": {
"message": "VALUE_FROM_RESPONSE"
}
}Notas: todos los datos personales y los objetos quedan limitados al sujeto del JWT.
Notas: la operación cambia el estado o continúa una autorización de un solo uso; el ejemplo describe el contrato y no se ejecuta.
GET /api/v1/user/profile — Perfil, saldo y vinculaciones
Acceso: token del panel de control
/api/v1/user/profilecurl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
-H "Authorization: Bearer $TOKEN"No se necesita cuerpo de solicitud. Envía los parámetros anteriores en la URL.
Respuesta
La respuesta JSON contiene code, message y data. El contenido de data se describe en los esquemas siguientes.
Esquemas de datos de la respuesta: User, UserProfileResponse. Los campos y los tipos se describen en las páginas «Esquemas de datos».
{
"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)"
}
}Notas: todos los datos personales y los objetos quedan limitados al sujeto del JWT.
Notas: los límites de gasto de las claves (quota, quota_used) se devuelven en la respuesta de las claves, no en el perfil. frozen_balance es el importe reservado y no se puede considerar saldo disponible.
GET /api/v1/user/totp/status — Estado de 2FA (TOTP)
Acceso: token del panel de control
/api/v1/user/totp/statuscurl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
-H "Authorization: Bearer $TOKEN"No se necesita cuerpo de solicitud. Envía los parámetros anteriores en la URL.
Respuesta
La respuesta JSON contiene code, message y data. El contenido de data se describe en los esquemas siguientes.
Esquemas de datos de la respuesta: TotpStatusResponse. Los campos y los tipos se describen en las páginas «Esquemas de datos».
{
"code": 0,
"message": "success",
"data": {
"enabled": "PLACEHOLDER_ENABLED (boolean)",
"enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
"feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}
}Notas: todos los datos personales y los objetos quedan limitados al sujeto del JWT.
Notas: secret y setup_token son secretos; la verificación depende de la configuración de TOTP y del usuario.
GET /api/v1/user/totp/verification-method — Método de verificación TOTP
Acceso: token del panel de control
/api/v1/user/totp/verification-methodcurl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
-H "Authorization: Bearer $TOKEN"No se necesita cuerpo de solicitud. Envía los parámetros anteriores en la URL.
Respuesta
La respuesta JSON contiene code, message y data. El contenido de data se describe en los esquemas siguientes.
{
"code": 0,
"message": "success",
"data": {
"method": "email"
}
}Notas: todos los datos personales y los objetos quedan limitados al sujeto del JWT.
Notas: secret y setup_token son secretos; la verificación depende de la configuración de TOTP y del usuario.
TotpVerificationMethod
{
"type": "object",
"required": [
"method"
],
"properties": {
"method": {
"type": "string",
"enum": [
"email",
"password"
]
}
}
}