POST 登录
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | POST |
| 接口地址 | /console/v1/login |
| 所属业务 | 认证安全 |
| 来源模块/系统 | 登录注册 |
| 认证方式 | 无需认证 |
完整请求
登录请求
正在加载示例…登录失败请求
正在加载示例…接口说明
登录
请求体
正在加载示例…正在加载示例…请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | 是 | — |
| body.type | body | string | 是 | 登录类型 code验证码登录 password密码登录 |
| body.account | body | string | 是 | 手机号或邮箱 |
| body.phone_code | body | string | 否 | 国家区号 手机号登录时需要传此参数 |
| body.code | body | string | 否 | 验证码 登录类型为验证码登录code时需要传此参数 |
| body.password | body | string | 否 | 密码 登录类型为密码登录password时需要传此参数 |
| body.remember_password | body | string | 否 | 记住密码 登录类型为密码登录password时需要传此参数 1是 0否 |
| body.captcha | body | string | 否 | 图形验证码 开启登录图形验证码且为密码登录时或者同一ip地址登录失败3次后需要传此参数 |
| body.token | body | string | 否 | 图形验证码唯一识别码 开启登录图形验证码且为密码登录时或者同一ip地址登录失败3次后需要传此参数 |
| body.customfield | body | object | 否 | 自定义字段 格式{"field1":"test","field2":"test2"} |
| body.client_operate_password | body | string | 否 | 操作密码 兼容旧版 |
| body.security_verify_method | body | string | 否 | 安全验证方式 operate_password操作密码 email_code邮箱验证码 phone_code手机验证码 certification实名校验 |
| body.security_verify_value | body | string | 否 | 安全验证值 操作密码或验证码 |
| body.certify_id | body | string | 否 | 实名认证ID 实名校验时需要 |
| body.security_verify_token | body | string | 否 | 安全验证token 异常登录时返回的token需要传安全验证方式对应返回的security_verify_token |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| data | object | 否 | — | — | — |
| data.jwt | string | 否 | — | — | jwt 登录后放在请求头Authorization里拼接成如下格式Bearer空格yJ0eX.test.ste |
| data.need_security_verify | boolean | 否 | — | — | 是否需要安全验证 |
| data.client_id | integer(int32) | 否 | — | — | 用户ID 需要安全验证时返回用于发送验证码 |
| data.available_methods | [string] | 否 | — | — | 可用的验证方式列表 |
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |