版本 2.4.8 · 最新
登录认证 auth
找回密码。登录、令牌与动态口令等接口只供控制台使用,不对外开放。
点击任一接口,右侧显示对应的调用示例。
鉴权: 无需鉴权1 个接口
鉴权
请求头带 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。
POST
/api/v2/auth/password-reset找回密码
鉴权: 无需鉴权
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
channel必填 | string | 按邮箱还是手机号找回。 |
code必填 | string | 发到 target 的验证码(POST /verify-codes,purpose=reset_password)。 |
new_password必填 | string | 新口令,8 到 128 个字符。 |
target必填 | string | 账号绑定的邮箱或手机号。 |
登录认证对象
| 字段 | 类型 | 说明 |
|---|---|---|
channel必填 | string | 按邮箱还是手机号找回。 |
code必填 | string | 发到 target 的验证码(POST /verify-codes,purpose=reset_password)。 |
new_password必填 | string | 新口令,8 到 128 个字符。 |
target必填 | 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"
}