清源SCA
社区版

中文

English

中文

English

主题

登录 ​

注册获取验证码 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/email_user/register_code/query
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json
Accept-Languagezh-CN、en-US

Body ​

参数名称说明in是否必须类型schema
emailUserRegisterCodeRequest邮箱账户注册获取验证码请求对象bodytrueEmailUserRegisterCodeRequestEmailUserRegisterCodeRequest

schema属性说明

EmailUserRegisterCodeRequest

参数名称说明in是否必须类型schema
email邮箱bodytruestring

请求示例 ​

json
{
	"email": "ikag23@qq.com"
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
110006请输入有效的邮箱地址
110007验证码发送过于频繁请稍后再试
190000邮件配置不存在
190001邮件发送失败

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100002：缺少必填参数{0}！
    • 110006：请输入有效的邮箱地址
    • 110007：验证码发送过于频繁请稍后再试
    • 190000：邮件配置不存在
    • 190001：邮件发送失败

响应参数 ​

参数名称说明类型schema
codestring
dataobject
messagestring
successboolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": null,
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数email！",
    "data": null,
    "success": false
}

{
    "code": "110006",
    "message": "请输入有效的邮箱地址",
    "data": null,
    "success": false
}

{
    "code": "110007",
    "message": "验证码发送过于频繁请稍后再试",
    "data": null,
    "success": false
}

{
    "code": "190000",
    "message": "邮件配置不存在",
    "data": null,
    "success": false
}

{
    "code": "190001",
    "message": "邮件发送失败",
    "data": null,
    "success": false
}

邮箱注册 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/email_user/register
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json
Accept-Languagezh-CN、en-US

Body ​

参数名称说明in是否必须类型schema
emailUserRegisterRequest邮箱用户注册请求对象bodytrueEmailUserRegisterRequestEmailUserRegisterRequest

schema属性说明

EmailUserRegisterRequest

参数名称说明in是否必须类型schema
email邮箱bodytruestring
code验证码bodytruestring
passwordRSA加密密码bodytruestring
checkPasswordRSA加密确认密码bodytruestring

请求示例 ​

json
{
	"email": "ikag23@qq.com",
	"code": "423325",
	"password": "bjvRCXxCZrjAPWGvLlV9ZuuTq395168cPSGO+D+gaSl4kLaDr75lXRGxLMzBWsjcOEjIKk2o3mFtvTL0c181tsGYeck9HiXvWrtHRSCjL+ZdL8dIITmMBzofFfiVcKuP/2FdDdhH1BPBouAIdEH3E7ywzFLqBl0oSBTXOZ56NTFnZkKLmLeqMwMIn30KXlRsYZ/kX8SzVkW4Poe8h/b8BQxH4O09B6qY876/TT1XhH6k8J+YxBstMfZpzHt0NRna6go6104FI0viDKN9nr+CbTP6sG9ui2FFQuHveyRV/+6JPQcj2k+/J1Slb4e8t4dPR+kRHXAf8CzaV/6u6kkUIw==",
    "checkPassword": "DUTYqgLJzc47HrMxVsnpEoyyHRkP3uqeZJwL0dmfi4f/61XCgMq/IOMi4indYlWFl2VQ4wLxcztDaxUI6Tc4rJDyBGO4QO/82fXmkUJiD/9avSOe1InXslbT3HSYFcJuwl1v3eHAidGUmHYYfR/p6qtLcTvNf487l3eGkjjYn5g96mohVzCnzfArgUUWLyud/TcZGBnDK+dzDd9akBLwCCRSQW9PdMe2yVuGaNiccAH3Rd45Y9JBAaq6xuvd8g15+d0T9xPeQ3knSudKkoHnEhI9NJE52GoggAhpQcQnU5F5HhjCfPspx8W8zUxVPUlJGKk0rYIeEZkUm0lMmZFpDQ=="
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
110003请输入包含字母大小写、特殊字符、数字的8-16个字符
110005两次输入的密码不一致，请重新输入
110006请输入有效的邮箱地址
110008验证码已失效，请重新获取
110009验证码错误，请重新输入
110010邮箱已存在，请重新输入

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100002：缺少必填参数{0}！
    • 110003：请输入包含字母大小写、特殊字符、数字的8-16个字符
    • 110005：两次输入的密码不一致，请重新输入
    • 110006：请输入有效的邮箱地址
    • 110008：验证码已失效，请重新获取
    • 110009：验证码错误，请重新输入
    • 110010：邮箱已存在，请重新输入

响应参数 ​

参数名称说明类型schema
codestring
dataobject
messagestring
successboolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": null,
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数email！",
    "data": null,
    "success": false
}

{
    "code": "110003",
    "message": "请输入包含字母大小写、特殊字符、数字的8-16个字符",
    "data": null,
    "success": false
}

{
    "code": "110005",
    "message": "两次输入的密码不一致，请重新输入",
    "data": null,
    "success": false
}

{
    "code": "110006",
    "message": "请输入有效的邮箱地址",
    "data": null,
    "success": false
}

{
    "code": "110008",
    "message": "验证码已失效，请重新获取",
    "data": null,
    "success": false
}

{
    "code": "110009",
    "message": "验证码错误，请重新输入",
    "data": null,
    "success": false
}

{
    "code": "110010",
    "message": "邮箱已存在，请重新输入",
    "data": null,
    "success": false
}

邮箱登录 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/email_user/login
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json
Accept-Languagezh-CN、en-US

Body ​

参数名称说明in是否必须类型schema
emailUserLoginRequest邮箱用户登录请求对象bodytrueEmailUserLoginRequestEmailUserLoginRequest

schema属性说明

EmailUserLoginRequest

参数名称说明in是否必须类型schema
email邮箱bodytruestring
passwordRSA加密密码bodytruestring

请求示例 ​

json
{
	"email": "ikag23@qq.com",
	"password": "bjvRCXxCZrjAPWGvLlV9ZuuTq395168cPSGO+D+gaSl4kLaDr75lXRGxLMzBWsjcOEjIKk2o3mFtvTL0c181tsGYeck9HiXvWrtHRSCjL+ZdL8dIITmMBzofFfiVcKuP/2FdDdhH1BPBouAIdEH3E7ywzFLqBl0oSBTXOZ56NTFnZkKLmLeqMwMIn30KXlRsYZ/kX8SzVkW4Poe8h/b8BQxH4O09B6qY876/TT1XhH6k8J+YxBstMfZpzHt0NRna6go6104FI0viDKN9nr+CbTP6sG9ui2FFQuHveyRV/+6JPQcj2k+/J1Slb4e8t4dPR+kRHXAf8CzaV/6u6kkUIw=="
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
110001用户不存在
110002用户已被禁用
110003请输入包含字母大小写、特殊字符、数字的8-16个字符
110006请输入有效的邮箱地址
110012邮箱或密码错误，请重新输入

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100002：缺少必填参数{0}！
    • 110001：用户不存在
    • 110002：用户已被禁用
    • 110003：请输入包含字母大小写、特殊字符、数字的8-16个字符
    • 110006：请输入有效的邮箱地址
    • 110012：邮箱或密码错误，请重新输入

响应参数 ​

参数名称说明类型schema
codestring
dataCommonResult«EmailUserLoginResponse»CommonResult«EmailUserLoginResponse»
messagestring
successboolean

schema属性说明

EmailUserLoginResponse

参数名称说明类型schema
id用户Idint32
profilePicture头像string
userName昵称string

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": null,
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数email！",
    "data": null,
    "success": false
}

{
    "code": "110001",
    "message": "用户不存在",
    "data": null,
    "success": false
}

{
    "code": "110002",
    "message": "用户已被禁用",
    "data": null,
    "success": false
}

{
    "code": "110003",
    "message": "请输入包含字母大小写、特殊字符、数字的8-16个字符",
    "data": null,
    "success": false
}

{
    "code": "110006",
    "message": "请输入有效的邮箱地址",
    "data": null,
    "success": false
}

{
    "code": "110012",
    "message": "邮箱或密码错误，请重新输入",
    "data": null,
    "success": false
}

忘记密码获取验证码 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/email_user/password_reset_code/get
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json
Accept-Languagezh-CN、en-US

Body ​

参数名称说明in是否必须类型schema
emailUserResetPasswordCodeRequest邮箱账户忘记密码获取验证码请求对象bodytrueEmailUserResetPasswordCodeRequestEmailUserResetPasswordCodeRequest

schema属性说明

EmailUserResetPasswordCodeRequest

参数名称说明in是否必须类型schema
email邮箱bodytruestring

请求示例 ​

json
{
	"email": "ikag23@qq.com"
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
110006请输入有效的邮箱地址
110007验证码发送过于频繁请稍后再试
190000邮件配置不存在
190001邮件发送失败

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100002：缺少必填参数{0}！
    • 110006：请输入有效的邮箱地址
    • 110007：验证码发送过于频繁请稍后再试
    • 190000：邮件配置不存在
    • 190001：邮件发送失败

响应参数 ​

参数名称说明类型schema
codestring
dataobject
messagestring
successboolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": null,
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数email！",
    "data": null,
    "success": false
}

{
    "code": "110006",
    "message": "请输入有效的邮箱地址",
    "data": null,
    "success": false
}

{
    "code": "110007",
    "message": "验证码发送过于频繁请稍后再试",
    "data": null,
    "success": false
}

{
    "code": "190000",
    "message": "邮件配置不存在",
    "data": null,
    "success": false
}

{
    "code": "190001",
    "message": "邮件发送失败",
    "data": null,
    "success": false
}

邮箱密码重置 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/email_user/password/reset
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json
Accept-Languagezh-CN、en-US

Body ​

参数名称说明in是否必须类型schema
emailUserPasswordResetRequest邮箱用户忘记密码请求对象bodytrueEmailUserPasswordResetRequestEmailUserPasswordResetRequest

schema属性说明

EmailUserForgotRequest

参数名称说明in是否必须类型schema
email邮箱bodytruestring
code验证码bodytruestring
passwordRSA加密密码bodytruestring
checkPasswordRSA加密确认密码bodytruestring

请求示例 ​

json
{
	"email": "ikag23@qq.com",
	"code": "423325",
	"password": "bjvRCXxCZrjAPWGvLlV9ZuuTq395168cPSGO+D+gaSl4kLaDr75lXRGxLMzBWsjcOEjIKk2o3mFtvTL0c181tsGYeck9HiXvWrtHRSCjL+ZdL8dIITmMBzofFfiVcKuP/2FdDdhH1BPBouAIdEH3E7ywzFLqBl0oSBTXOZ56NTFnZkKLmLeqMwMIn30KXlRsYZ/kX8SzVkW4Poe8h/b8BQxH4O09B6qY876/TT1XhH6k8J+YxBstMfZpzHt0NRna6go6104FI0viDKN9nr+CbTP6sG9ui2FFQuHveyRV/+6JPQcj2k+/J1Slb4e8t4dPR+kRHXAf8CzaV/6u6kkUIw==",
    "checkPassword": "DUTYqgLJzc47HrMxVsnpEoyyHRkP3uqeZJwL0dmfi4f/61XCgMq/IOMi4indYlWFl2VQ4wLxcztDaxUI6Tc4rJDyBGO4QO/82fXmkUJiD/9avSOe1InXslbT3HSYFcJuwl1v3eHAidGUmHYYfR/p6qtLcTvNf487l3eGkjjYn5g96mohVzCnzfArgUUWLyud/TcZGBnDK+dzDd9akBLwCCRSQW9PdMe2yVuGaNiccAH3Rd45Y9JBAaq6xuvd8g15+d0T9xPeQ3knSudKkoHnEhI9NJE52GoggAhpQcQnU5F5HhjCfPspx8W8zUxVPUlJGKk0rYIeEZkUm0lMmZFpDQ=="
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
110001用户不存在
110002用户已被禁用
110003请输入包含字母大小写、特殊字符、数字的8-16个字符
110005两次输入的密码不一致，请重新输入
110006请输入有效的邮箱地址
110008验证码已失效，请重新获取
110009验证码错误，请重新输入

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100002：缺少必填参数{0}！
    • 110001：用户不存在
    • 110002：用户已被禁用
    • 110003：请输入包含字母大小写、特殊字符、数字的8-16个字符
    • 110005：两次输入的密码不一致，请重新输入
    • 110006：请输入有效的邮箱地址
    • 110008：验证码已失效，请重新获取
    • 110009：验证码错误，请重新输入

响应参数 ​

参数名称说明类型schema
codestring
dataobject
messagestring
successboolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": null,
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数email！",
    "data": null,
    "success": false
}

{
    "code": "110001",
    "message": "用户不存在",
    "data": null,
    "success": false
}

{
    "code": "110002",
    "message": "用户已被禁用",
    "data": null,
    "success": false
}

{
    "code": "110003",
    "message": "请输入包含字母大小写、特殊字符、数字的8-16个字符",
    "data": null,
    "success": false
}

{
    "code": "110005",
    "message": "两次输入的密码不一致，请重新输入",
    "data": null,
    "success": false
}

{
    "code": "110006",
    "message": "请输入有效的邮箱地址",
    "data": null,
    "success": false
}

{
    "code": "110008",
    "message": "验证码已失效，请重新获取",
    "data": null,
    "success": false
}

{
    "code": "110009",
    "message": "验证码错误，请重新输入",
    "data": null,
    "success": false
}

获取微信登录二维码url ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/wx/login/qr_code
  • Method：GET

请求参数 ​

Headers ​

Body ​

参数名称说明in是否必须类型schema
无参数

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100005系统异常

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100005：系统异常!

响应参数 ​

参数名称说明类型schema
code状态码string
data返回数据CommonResult<WxLoginResponse>
message返回信息string
success是否成功boolean

schema 属性说明

CommonResult<WxLoginResponse>

参数名称说明类型schema
qrCodeUrl二维码地址string
uuid二维码唯一标识string

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "qrCodeUrl": "https://open.weixin.qq.com/connect/qrconnect?appid=xxx&redirect_uri=http%3A%2F%2Fxxx%2Fcallback%3Fuuid%3D34a89e29-a8a8-4dc8-b74a-e78f9ea968c8&response_type=code&scope=snsapi_login&state=STATE#wechat_redirect",
    "uuid": "34a89e29-a8a8-4dc8-b74a-e78f9ea968c8"
  },
  "success": true
}

失败响应示例 ​

json
{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

微信登录状态获取 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/wx/status
  • Method：GET

请求参数 ​

Headers ​

Body ​

参数名称说明in是否必须类型schema
uuid微信登录二维码唯一标识querytruestringstring

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult<integer>
201Created
401Unauthorized
403Forbidden
404Not Found
100005系统异常

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100005：系统异常!

响应参数 ​

参数名称说明类型schema
code状态码string
data返回数据integer
message返回信息string
success是否成功boolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": 0,
  "success": true
}

失败响应示例 ​

json
{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

获取用户微信绑定链接 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/wx/bind/qr_code
  • Method：GET

请求参数 ​

Headers ​

Body ​

参数名称说明in是否必须类型schema
id当前登录用户IDquerytrueinteger

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100005系统异常

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100005：系统异常!

响应参数 ​

参数名称说明类型schema
code状态码string
data返回数据CommonResult<WxLoginResponse>
message返回信息string
success是否成功boolean

schema 属性说明

CommonResult<WxLoginResponse>

参数名称说明类型schema
qrCodeUrl二维码地址string
uuid二维码唯一标识string

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "qrCodeUrl": "https://open.weixin.qq.com/connect/qrconnect?appid=xxx&redirect_uri=http%3A%2F%2Fxxx%2Fcallback%3Fuuid%3D34a89e29-a8a8-4dc8-b74a-e78f9ea968c8&response_type=code&scope=snsapi_login&state=STATE#wechat_redirect",
    "uuid": "34a89e29-a8a8-4dc8-b74a-e78f9ea968c8"
  },
  "success": true
}

失败响应示例 ​

json
{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

获取验证码的图形校验码 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/phone_login/captcha/get
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json

Body ​

参数名称说明in是否必须类型schema
request图形校验码请求参数bodytrueGetCaptchaCodeRequestGetCaptchaCodeRequest

schema属性说明

GetCaptchaCodeRequest

参数名称说明in是否必须类型schema
mathMode验证模式 1：算术式验证、2：数字验证 无效数值时则默认算术式验证模式bodytrueint32
phone手机号bodytruestring

请求示例 ​

json
{
	"mathMode": 1,
	"phone": ""
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
200001请输入正确的手机号!

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100002：缺少必填参数{0}！
    • 200001：请输入正确的手机号!

响应参数 ​

参数名称说明类型schema
codestring
datastring
messagestring
successboolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKAAAAA8CAIAAABuCSZCAAAC40lEQVR4Xu2YW24DIQwAc/9T5WZUqitEbPwADKFej/gpfrKj/PRVktC88EUSixQcnBQcnBQcnBTc4f1+46t/SwrGRLJbUjAimN2SghEpODLx7JYUXAlpt6RgIKrdkoKBFByZwHZLCo5ttzxccHi75cmCn2C33Cb4/Qu+3cOxQd/FR/Dr9XdUaqZQMqpZbUgZ6j8NfaxxPUccBtq3p68VqiyaaSu5J6C2XYfuY9zNndVp9tXpO42FHLSJpefX7crrubM0x740zaRnFNpBbXjAbiGLcaEzTM6hX1Nemsvh7lW4udw9cECwvEBZePIcM0PQGywbczncvYpQyIUO2C389Iqa4MvMELSiurGcIEe7TJRwdttW6nHBvaHMzBC0n7qxnCBHu4yWcHZLCu6CNlM3lhPkaBdU0v7ZbXKPYN9uFhzmqEvLCXK0S1vCnYpgt9ha0Z4T+Haz4zBHXVpOkKNd2hLhFM3uMbq7ncFhlLq3nCBHu7Qlwolqd+hdy9MMhuQELtreoxx6w1V9Hd99LP++RSzP5A1V5AQu2t6jHK4EkKMI2l84EyyWVybUAmtjf1HfICdw0fYe5XAlgBxF0P7CmWCxvCyoBWbHNqhvkBO4aHuPcrgSQI4iaH/hTLBYvqIWmBr7ieUNXA53ryJUDfVsk9VzksUfbsVha8sn4HK4exWusL0f7XkJXmoBh29g+aDou3fPELScnhsY2sdXLWAYq2F8AxVgLOSgTdZ7umPcZ4daQBxrw/iGwiuZhrZa7+mLZaVNagF+rBnLGyo7TLg3dERebN8Pt9Ibm+zngFogBZ/mmFogBa8Cwuzg+s08RTD+zH7gSQxDyY7cJfjz03mCJx3kuwtsF/z5nRVw8T/nhkdtF/xMblALpGB/LlELpGBP7vnhVlIwC9gyCrNnHiYF/1F1VnAGw1DyeZ4r+NPmpKHpwmM8RTDSeb8YL4ILfppOSnDBSQoOTgoOTgoOTgoOTgoOzg+ZwKe89ty1hAAAAABJRU5ErkJggg==",
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数phone！",
    "data": null,
    "success": false
}

{
  "code": "200001",
  "message": "请输入正确的手机号!",
  "data": null,
  "success": false
}

手机获取验证码 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/phone_login/code/get
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json

Body ​

参数名称说明in是否必须类型schema
request获取验证码参数bodytrueGetCodeRequestGetCodeRequest

schema属性说明

GetCodeRequest

参数名称说明in是否必须类型schema
captchaCode图形验证码答案bodytruestring
phone手机号bodytruestring

请求示例 ​

json
{
	"captchaCode": "",
	"phone": ""
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100002缺少必填参数{0}！
100005系统异常!
200001请输入正确的手机号!
200004验证码发送失败!
200005验证码发送过于频繁请稍后再试!
200012答案错误，请重新输入！

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100005：系统异常!

    • 200001：请输入正确的手机号!

    • 200004：验证码发送失败!

    • 200005：验证码发送过于频繁请稍后再试!

    • 200012：答案错误，请重新输入！

响应参数 ​

参数名称说明类型schema
codestring
datastring
messagestring
successboolean

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": "COMMON_SUCCESS",
  "success": true
}

失败响应示例 ​

json
{
    "code": "100002",
    "message": "缺少必填参数phone！",
    "data": null,
    "success": false
}

{
  "code": "200001",
  "message": "请输入正确的手机号!",
  "data": null,
  "success": false
}

{
  "code": "200004",
  "message": "验证码发送失败!",
  "data": null,
  "success": false
}

{
  "code": "200005",
  "message": "验证码发送过于频繁请稍后再试!",
  "data": null,
  "success": false
}


{
  "code": "200012",
  "message": "答案错误，请重新输入！",
  "data": null,
  "success": false
}

{
  "code": "100005",
  "message": "系统异常",
  "data": null,
  "success": false
}

手机号登录 ​

基本信息 ​

  • Path：{{ host }} /cleansourcesca-community/phone_login/login
  • Method：POST

请求参数 ​

Headers ​

参数名称参数值
Content-Typeapplication/json

Body ​

参数名称说明in是否必须类型schema
req手机号登录参数bodytruePhoneLoginRequestPhoneLoginRequest

schema属性说明

PhoneLoginRequest

参数名称说明in是否必须类型schema
phone手机号bodytruestring
code验证码bodytruestring

请求示例 ​

json
{
	"code": "",
	"phone": ""
}

响应数据 ​

响应状态码 ​

状态码说明schema
100000OKCommonResult
201Created
401Unauthorized
403Forbidden
404Not Found
100005系统异常

  • 操作成功响应状态码：100000

  • 错误码描述：

    • 100005：系统异常!

    • 200000：请输入手机号和验证码!

    • 200001：请输入正确的手机号!

    • 200002：验证码已失效,请重新获取!

    • 200003：验证码错误,请重新输入!

    • 200010：用户已被禁用!

    • 200011：用户已被删除!

响应参数 ​

参数名称说明类型schema
codestring
dataPhoneLoginResponsePhoneLoginResponse
messagestring
successboolean

schema属性说明

PhoneLoginResponse

参数名称说明类型schema
id用户IDint64
profilePicture用户头像string
userName用户昵称string

成功响应示例 ​

json
{
  "code": "100000",
  "message": "操作成功",
  "data": {
    "id": 13,
    "profilePicture": null,
    "userName": "2684126442@qq.com"
  },
  "success": true
}

失败响应示例 ​

json
{
  "code": "100005",
  "message": "系统异常!",
  "data": null,
  "success": false
}

{
  "code": "200000",
  "message": "请输入手机号和验证码！",
  "data": null,
  "success": false
}

{
  "code": "200001",
  "message": "请输入正确的手机号！",
  "data": null,
  "success": false
}

{
  "code": "200002",
  "message": "验证码已失效,请重新获取！",
  "data": null,
  "success": false
}

{
  "code": "200003",
  "message": "验证码错误,请重新输入！",
  "data": null,
  "success": false
}

{
  "code": "200010",
  "message": "用户已被禁用！",
  "data": null,
  "success": false
}

{
  "code": "200011",
  "message": "用户已被删除！",
  "data": null,
  "success": false
}