主题
登录注册
登录
| 项目 | 内容 |
|---|---|
| 接口描述 | 登录 |
| 接口地址 | /console/v1/login |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| type | string | code | code验证码登录password密码登录validate:required | desc:登录类型 |
| account | string | 18423467948 | validate:required | desc:手机号或邮箱 |
| phone_code | string | 86 | 手机号登录时需要传此参数validate:optional | desc:国家区号 |
| code | string | 1234 | 登录类型为验证码登录code时需要传此参数validate:optional | desc:验证码 |
| password | string | 123456 | 登录类型为密码登录password时需要传此参数validate:optional | desc:密码 |
| remember_password | string | 1 | 登录类型为密码登录password时需要传此参数1是0否validate:optional | desc:记住密码 |
| captcha | string | 1234 | 开启登录图形验证码且为密码登录时或者同一ip地址登录失败3次后需要传此参数validate:optional | desc:图形验证码 |
| token | string | fd5adaf7267a5b2996cc113e45b38f05 | 开启登录图形验证码且为密码登录时或者同一ip地址登录失败3次后需要传此参数validate:optional | desc:图形验证码唯一识别码 |
| customfield | object | {} | 格式{"field1":"test","field2":"test2"}validate:optional | desc:自定义字段 |
| client_operate_password | string | - | 兼容旧版validate:optional | desc:操作密码 |
| security_verify_method | string | - | operate_password操作密码email_code邮箱验证码phone_code手机验证码certification实名校验validate:optional | desc:安全验证方式 |
| security_verify_value | string | - | 操作密码或验证码validate:optional | desc:安全验证值 |
| certify_id | string | - | 实名校验时需要validate:optional | desc:实名认证ID |
| security_verify_token | string | - | 异常登录时返回的token需要传安全验证方式对应返回的security_verify_tokenvalidate:optional | desc:安全验证token |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.jwt | string | - | desc:jwt |
| data.need_security_verify | bool | - | desc:是否需要安全验证 |
| data.client_id | int | - | desc:用户ID |
| data.available_methods | array | - | desc:可用的验证方式列表 |
注册
| 项目 | 内容 |
|---|---|
| 接口描述 | 注册 |
| 接口地址 | /console/v1/register |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| type | string | phone | phone手机注册email邮箱注册validate:required | desc:注册类型 |
| account | string | 18423467948 | validate:required | desc:手机号或邮箱 |
| phone_code | string | 86 | 注册类型为手机注册时需要传此参数validate:optional | desc:国家区号 |
| username | string | wyh | validate:optional | desc:姓名 |
| code | string | 1234 | validate:required | desc:验证码 |
| password | string | 123456 | validate:required | desc:密码 |
| re_password | string | 1 | validate:required | desc:重复密码 |
| customfield | object | {} | 格式{"field1":"test","field2":"test2"}validate:optional | desc:自定义字段 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.jwt | string | - | desc:jwt |
忘记密码
| 项目 | 内容 |
|---|---|
| 接口描述 | 忘记密码 |
| 接口地址 | /console/v1/account/password_reset |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| type | string | phone | phone手机注册email邮箱注册validate:required | desc:注册类型 |
| account | string | 18423467948 | validate:required | desc:手机号或邮箱 |
| phone_code | string | 86 | 注册类型为手机注册时需要传此参数validate:optional | desc:国家区号 |
| code | string | 1234 | validate:required | desc:验证码 |
| password | string | 123456 | validate:required | desc:密码 |
| re_password | string | 1 | validate:required | desc:重复密码 |
响应参数
无
创建实名认证
| 项目 | 内容 |
|---|---|
| 接口描述 | 创建实名认证会话,返回二维码URL |
| 接口地址 | /console/v1/login/exception/certification/create |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| account | string | - | validate:required | desc:账户 |
| phone_code | string | - | validate:optional | desc:手机区号 |
| security_verify_token | string | - | 相应操作接口返回的token防止被刷validate:required | desc:安全验证token |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.certify_id | string | - | desc:认证ID |
| data.certify_url | string | - | desc:认证URL |
查询实名认证状态
| 项目 | 内容 |
|---|---|
| 接口描述 | 轮询查询实名认证状态 |
| 接口地址 | /console/v1/login/exception/certification/status |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| account | string | - | validate:required | desc:账户 |
| phone_code | string | - | validate:optional | desc:手机区号 |
| security_verify_token | string | - | 相应操作接口返回的token防止被刷validate:required | desc:安全验证token |
| certify_id | string | - | validate:required | desc:认证ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.verify_status | int | - | desc:状态 |