简要描述:

  • 账号密码登录

接口版本:

版本号 制定人 制定日期 修订日期
v3 陈碧贵 2019-01-20 xxxx-xx-xx

请求URL:

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
XownerId string 项目唯一ID,对应bo_project {ownerId}
XsysId string 所属系统 对应 bo_system 表
XuserFromFirstShareId string 一级分享用户ID, bo_user user_id
XuserFromSecondShareId string 二级分享用户ID, bo_user user_id
XverifyApi string 加密规则encryptByDES(`${newGuid()}
XfilterAreaCode string 行政区编码, 对应 bo_sys_area area_code
Content-Type: string application/json; charset=utf-8 请求类型

请求参数:

{
        websoketId:"websoketId当前应用唯一ID,如果不传递不进行ws推送",
        userName: "TEST",
        verifyCode: "fywn",
        verifyGuid: "rg0103ee425a0-6617-4fff-80e5-eb069ed",
        password: "3Cn3ntq85hrzxmbF/ZoyEA==",
        loginType: "userName",
 }
参数名 是否必须 类型 说明
depId string 主键唯一标识值 (名称根据实际进行调整)
_nodejs string common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线
数据参数名 是否必须 类型 说明
userName string 登录账号
password string 密码,加密后,encryptByDES规则
loginType string 登录类型,userName
verifyGuid string 验证KEY
verifyCode string 验证码,根据后端配置是否必须
#### 返回示例:

正确时返回:

{
        token: {
          tokenType: "Bearer",
          timeStamp: 1611309530975.2864,
          refreshToken: "vSMmvxYBYAtyNcmrOU8ie1g1mXpakjRP",
          accessToken:
            "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJSRzMiLCJhdWQiOiJhcGkiLCJpZCI6InB0ZGV2IiwibmFtZSI6ImRldiIsImNsaWVudF9pZCI6InB0ZGV2Iiwib3Blbl9pZCI6IiIsIndiX2lkIjoiIiwid3hfb3Blbl9pZCI6IiIsInd4X3VuaW9uX2lkIjoiIiwidGVsZXBob25lIjoiIiwicHVzaF9uYW1lIjoi5byA5Y-R566h55CG5ZGYIiwiaGVhZF9pY29uIjoiIiwiZGVwX2lkIjoiIiwic3lzX2lkIjoiIiwibWVyZ2VfdXNlcl9pZCI6IiIsImFyZWFfY29kZSI6IiIsInJvbGVfaWQiOiJkZXZlbG9wbWVudCIsImRldmVsb3BlciI6IjEiLCJuYmYiOjE2MTEzMDkyMzAsImV4cCI6MTYxMTMwOTUzMCwiaWF0IjoxNjExMzA5MjMwfQ.XtYVbsJFpzWb0kA26sgLSHu17_sYScIll2_Js1ujVGg",
          expires: "2021-01-29T17:58:50",
        },
        user: {
          headIcon: "",
          userId: "test",
          roleId: ["development"],
          depId: [],
          pushName: "开发管理员",
          jobId: [],
          sysId: [],
          areaCode: [],
          developer: 1,
          mergeUserId: [],
          appId: [],
          userGroupId: [],
        },
        success: true,
      }

错误时返回:

{
    "code": 0,
    "message": ""
    "error":{
      errorCode:null,
      errorText:null
    }
    "success": false,
}

返回参数说明:

参数名 类型 说明
success bool true 表示数据请求成功(跟code=0一致),调用者优先使用
code int true 表示数据请求成功(跟code=0一致),调用者优先使用
data object 响应的结果数据 name:显示的名称 value:交互的数据库中值 id:通常和value一致,树形结构需要 parentId: 父节点,树形结构需要level:等级,树形结构需要
cacheType string redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化)
cacheDate date 最后数据获取时间
data参数名 类型 说明
token:accessToken string 存储用户认证信息
Authorization string Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
token:refreshToken string 如果用户认证过期,通过它重新获取accessToken
user string 存储当前用户信息
user: developer int =1 表示开发者账号,可以赋予最高操作
user: mergeUserId array 多账号共享
user: appId array 拥有的应用
user: userGroupId array 用户管理组
文档更新时间: 2023-02-03 08:12   作者:admin