获取验证码

简要描述

根据参数不同可支持获取图片验证码,短信验证码,

请求 URL

请求方式

  • POST

请求示例

{
  "type": "image",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名类型必选说明
typestring验证码类型,可选值:sms,image,scan
mobilestring当 type 为 sms 的时候需要传入该字段
deviceIdstring客户端会话唯一标识

返回示例

图片二进制流或短信验证码

返回参数

图片二进制流或短信验证码

账号密码登录获取 Token(在使用)

简要描述

用户使用账号密码登录管理系统并获取 token,使用 token 便可以拿到用户信息

请求 URL

请求方式

  • POST

请求示例

{
  "username": "admin",
  "password": "123456",
  "captcha": "5694",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名类型必选说明
usernamestring用户的登录账号
passwordstring用户的登录密码
captchastring图片验证码
deviceIdstring客户端会话唯一标识

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "accessToken": "baoj1xit1ajymp0jzyoz0nkm08778so8",
    "expiredTime": "1647767386251"
  },
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
accessTokenstringtoken
expiredTimestringtoken过期时间戳(秒)
successboolean是否成功

手机号短信验证码登录获取 Token(未使用)

简要描述

用户使用手机号短信验证码登录管理系统并获取 token,使用 token 便可以拿到用户信息

请求 URL

请求方式

  • POST

请求示例

{
  "mobile": "12345678901",
  "captcha": "5694",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名类型必选说明
mobilestring手机号
captchastring短信验证码
deviceIdstring客户端会话唯一标识

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "accessToken": "baoj1xit1ajymp0jzyoz0nkm08778so8",
    "expiredTime": "1647767386251"
  },
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
accessTokenstringtoken
expiredTimestringtoken过期时间戳(秒)
successboolean是否成功

用户邮箱注册

简要描述

用户通过邮箱注册账户并获取 token,然后使用 token 便可以拿到用户信息

请求 URL

请求方式

  • POST

请求示例

{
  "username": "admin",
  "password": "123456",
  "confirmPassword": "123456",
  "deviceId": "80c71a92-a2e6-4320-3bbe-38cfd6b19ab4"
}

请求参数

参数名类型必选说明
usernamestring用户的登录账号
passwordstring用户的登录密码
confirmPasswordstring用户的确认密码
deviceIdstring客户端会话唯一标识

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "accessToken": "baoj1xit1ajymp0jzyoz0nkm08778so8",
    "expiredTime": "1647767386251"
  },
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
accessTokenstringtoken
expiredTimestringtoken过期时间戳(秒)
successboolean是否成功

用 Token 换取用户信息

简要描述

使用 token 换取用户信息

请求 URL

请求方式

  • GET

请求示例

请求头需要添加 Authorization,值就是 Bearer + 空格 + token

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxx

请求参数

请求头需要添加 Authorization,值就是 Bearer + 空格 + token

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "id": "1",
    "username": "lijunping",
    "password": "$2a$10$3oNlO/vvXV3FPsmimv0x3ePTcwpe/E1xl86TDC0iLKwukWkJoRIyK",
    "phone": "12345678901",
    "status": 1,
    "createTime": "2021-06-24 15:53:16",
    "updateTime": "2021-06-24 15:53:19"
  },
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
idint用户唯一标识
usernamestring用户名
passwordstring密码
phonestring用户名
statusint用户状态 1 未锁定,0 锁定
createTimedate创建时间
updateTimedate更新时间
successboolean是否成功

用户退出

简要描述

用户退出接口,删除 cookie

请求 URL

请求方式

  • GET

请求示例

请求参数

返回示例

{
  "code": 200,
  "msg": "成功",
  "data": null,
  "success": true
}

返回参数

参数名类型说明
codeint200成功,非200失败
msgstring错误信息
successboolean是否成功