版本 2.4.7.20261116085428 · 最新
当前用户 me
当前登录用户查看或修改自己的资料与实名认证。
点击任一接口,右侧显示对应的调用示例。
用户账号鉴权: 用户4 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/me当前用户
鉴权: 用户
PUT
/api/v2/me修改个人资料
鉴权: 用户
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
email | string | 邮箱 |
email_code | string | 发到新邮箱的验证码(POST /verify-codes,purpose=bind);改邮箱时必填。 |
login_ip_allow | string[] | 登录 IP 白名单(IP 或 CIDR);空 = 不限。 |
login_verify | LoginVerify | 登录二次验证:none 不要求;email / sms 登录时还要邮件/短信验证码(须平台允许且已绑定对应地址)。 |
nickname | string | 昵称;没设为空(界面显示登录名)。 |
password | string | 当前登录口令;改邮箱、手机号、登录 IP 白名单、登录二次验证时与 totp_code 至少给一个。 |
phone | string | 手机号 |
phone_code | string | 发到新手机号的验证码(POST /verify-codes,purpose=bind);改手机号时必填。 |
totp_code | string | 动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。 |
POST
/api/v2/me/certification提交实名认证
鉴权: 用户
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
id_number必填 | string | 打码后的证件号。 |
real_name必填 | string | 打码后的姓名。 |
当前用户对象
| 字段 | 类型 | 说明 |
|---|---|---|
avatar_ver | integer | 头像版本,每次上传变大;没有头像为空。 |
balance_cents | integer | 账户余额(分),同 GET /users/{user_id}/account 的 balance_cents(无账户记 0)。只有 GET /users 列表带,单个用户的读写接口不带。 |
certified | boolean | 是否已通过实名认证。 |
client_ip | string | 本次请求的来源 IP,与登录 IP 白名单校验用的是同一个取法(白名单比什么就显示什么)。只有 GET /me、PUT /me 带。 |
created_at | string | 创建时间 |
currency | CurrencyBrief | 账户货币(ISO 4217)与符号,余额、充值、订单都按它记,面板金额显示用;没开过账户时为新用户默认。 |
delegated_session | boolean | 当前会话是否由超管代登录或切换为用户签发(是则口令、邮箱、手机号、登录白名单、二次验证与实名只读)。只有 GET /me、PUT /me 带。 |
email | string | 邮箱 |
email_code | string | 发到新邮箱的验证码(POST /verify-codes,purpose=bind);改邮箱时必填。 |
enabled | boolean | 是否启用 |
id | integer | 记录 ID |
id_number | string | 打码后的证件号。 |
ip_site_new | boolean | 名下有使用中(未到期)且开放 IP 网站的套餐:能新建 IP 网站、选新 IP、签 ZeroSSL 付费版(zerossl_api)证书、给 ZeroSSL 账号设 API Key。只有 GET /me 带;管理员恒为 true。 |
ip_site_on | boolean | ip_site_new 为 true,或名下已有 IP 网站、IP 证书(SAN 全是 IP)、配了 API Key 的 ZeroSSL 账号任一(免费 ZeroSSL 账号不算):IP 网站相关菜单与页签可见,已有数据可查看、编辑、删除。只有 GET /me 带;管理员恒为 true。 |
login_ip_allow | string[] | 登录 IP 白名单(IP 或 CIDR);空 = 不限。 |
login_verify | LoginVerify | 登录二次验证:none 不要求;email / sms 登录时还要邮件/短信验证码(须平台允许且已绑定对应地址)。 |
nickname | string | 昵称;没设为空(界面显示登录名)。 |
password | string | 当前登录口令;改邮箱、手机号、登录 IP 白名单、登录二次验证时与 totp_code 至少给一个。 |
phone | string | 手机号 |
phone_code | string | 发到新手机号的验证码(POST /verify-codes,purpose=bind);改手机号时必填。 |
provider | string | 实名认证通道。 |
real_name | string | 打码后的姓名。 |
reason | string | 未通过的原因。 |
role | string | 账号角色:admin 管理员,tenant 租户。 |
status | string | 实名状态:none 未认证,pending 待认证,verified 已通过,failed 未通过。 |
totp_code | string | 动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。 |
totp_enabled | boolean | 是否已启用动态口令。 |
totp_recovery_left | integer | 未用完的 TOTP 恢复码个数。只有 GET /me、PUT /me 且已启用动态口令时带。 |
updated_at | string | 更新时间 |
url | string | 待认证时用户要去的认证地址(仅提交时返回)。 |
username | string | 用户名 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}