Skip to content

登录注册 ​

登录 ​

项目内容
接口描述登录
接口地址/console/v1/login
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
typestringcodecode验证码登录password密码登录validate:requireddesc:登录类型
accountstring18423467948validate:requireddesc:手机号或邮箱
phone_codestring86手机号登录时需要传此参数validate:optionaldesc:国家区号
codestring1234登录类型为验证码登录code时需要传此参数validate:optionaldesc:验证码
passwordstring123456登录类型为密码登录password时需要传此参数validate:optionaldesc:密码
remember_passwordstring1登录类型为密码登录password时需要传此参数1是0否validate:optionaldesc:记住密码
captchastring1234开启登录图形验证码且为密码登录时或者同一ip地址登录失败3次后需要传此参数validate:optionaldesc:图形验证码
tokenstringfd5adaf7267a5b2996cc113e45b38f05开启登录图形验证码且为密码登录时或者同一ip地址登录失败3次后需要传此参数validate:optionaldesc:图形验证码唯一识别码
customfieldobject{}格式{"field1":"test","field2":"test2"}validate:optionaldesc:自定义字段
client_operate_passwordstring-兼容旧版validate:optionaldesc:操作密码
security_verify_methodstring-operate_password操作密码email_code邮箱验证码phone_code手机验证码certification实名校验validate:optionaldesc:安全验证方式
security_verify_valuestring-操作密码或验证码validate:optionaldesc:安全验证值
certify_idstring-实名校验时需要validate:optionaldesc:实名认证ID
security_verify_tokenstring-异常登录时返回的token需要传安全验证方式对应返回的security_verify_tokenvalidate:optionaldesc:安全验证token

响应参数

nametypedefaultdesc
data.jwtstring-desc:jwt
data.need_security_verifybool-desc:是否需要安全验证
data.client_idint-desc:用户ID
data.available_methodsarray-desc:可用的验证方式列表

注册 ​

项目内容
接口描述注册
接口地址/console/v1/register
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
typestringphonephone手机注册email邮箱注册validate:requireddesc:注册类型
accountstring18423467948validate:requireddesc:手机号或邮箱
phone_codestring86注册类型为手机注册时需要传此参数validate:optionaldesc:国家区号
usernamestringwyhvalidate:optionaldesc:姓名
codestring1234validate:requireddesc:验证码
passwordstring123456validate:requireddesc:密码
re_passwordstring1validate:requireddesc:重复密码
customfieldobject{}格式{"field1":"test","field2":"test2"}validate:optionaldesc:自定义字段

响应参数

nametypedefaultdesc
data.jwtstring-desc:jwt

忘记密码 ​

项目内容
接口描述忘记密码
接口地址/console/v1/account/password_reset
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
typestringphonephone手机注册email邮箱注册validate:requireddesc:注册类型
accountstring18423467948validate:requireddesc:手机号或邮箱
phone_codestring86注册类型为手机注册时需要传此参数validate:optionaldesc:国家区号
codestring1234validate:requireddesc:验证码
passwordstring123456validate:requireddesc:密码
re_passwordstring1validate:requireddesc:重复密码

响应参数

无

创建实名认证 ​

项目内容
接口描述创建实名认证会话,返回二维码URL
接口地址/console/v1/login/exception/certification/create
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
accountstring-validate:requireddesc:账户
phone_codestring-validate:optionaldesc:手机区号
security_verify_tokenstring-相应操作接口返回的token防止被刷validate:requireddesc:安全验证token

响应参数

nametypedefaultdesc
data.certify_idstring-desc:认证ID
data.certify_urlstring-desc:认证URL

查询实名认证状态 ​

项目内容
接口描述轮询查询实名认证状态
接口地址/console/v1/login/exception/certification/status
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
accountstring-validate:requireddesc:账户
phone_codestring-validate:optionaldesc:手机区号
security_verify_tokenstring-相应操作接口返回的token防止被刷validate:requireddesc:安全验证token
certify_idstring-validate:requireddesc:认证ID

响应参数

nametypedefaultdesc
data.verify_statusint-desc:状态