账户

创建用户

接口说明

根据用户信息创建用户

请求信息

配置说明	参数值
URL	`/user`
Method	`POST`
Content-Type	`application/json`

Body参数

参数名	类型	描述	是否必填
username	string	用户名，登录时的账户名,最长50位	是
real_name	string	真实姓名，最长100位	否
password	string	用户密码，最长200位	是
nickname	string	昵称，最长100位	否
gender	int32	性别，`1`=男性，`2`=女性	否
email	string	邮箱	否
phone	string	手机号	否
department	string	部门	否
avatar	string	头像，最长250位	否
unique_code	string	用户唯一编码，最长50位	否

Body数据样例

json

{
  "username": "testname",
  "real_name": "张三",
  "password": "123456",
  "nickname": "大张伟",
  "gender": 1,
  "email": "test@qq.com",
  "phone": "15699999999",
  "department": "销售部",
  "avatar": "https://f-dev.clobotics.cn/4/0040ca4d85f5e5ef7354102f486ef843.jpg",
  "unique_code": "uuytr"
}

数据响应

`data`数据格式

参数名	类型	描述
id	int64	用户id
username	string	用户名，登录时的账户名
real_name	string	真实姓名
password	string	用户密码
nickname	string	昵称
gender	int32	性别，`1`=男性，`2`=女性
email	string	邮箱
phone	string	手机号
department	string	部门
avatar	string	头像
unique_code	string	用户唯一编码

响应数据样例

json

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 9837366,
    "username": "testname",
    "real_name": "张三",
    "password": "123456",
    "nickname": "大张伟",
    "gender": 1,
    "email": "test@qq.com",
    "phone": "15699999999",
    "department": "销售部",
    "avatar": "https://f-dev.clobotics.cn/4/0040ca4d85f5e5ef7354102f486ef843.jpg",
    "unique_code": "uuytr"
  }
}

查询用户

接口说明

根据用户id查询用户信息。

请求信息

配置说明	参数值
URL	`/user?user_id=2132&username=test`
Method	`GET`

请求参数

参数名	类型	描述	是否必填
user_id	int64	用户id，用户id和用户名二选一	否
username	string	用户名，用户id和用户名二选一	否

响应数据

`data`数据格式

参数名	类型	描述
id	int64	用户id
username	string	用户名，登录时的账户名
real_name	string	真实姓名
nickname	string	昵称
gender	int32	性别，`1`=男性，`2`=女性
email	string	邮箱
phone	string	手机号
department	string	部门
avatar	string	头像
roles	[]object	用户角色列表，现阶段只有一个角色
+ id	int64	角色id
+ name	string	角色名称
+ system_id	int64	角色对应的系统id
+ order	int32	序号
+ description	string	角色描述
orgs	[]object	用户组织列表，现阶段只有一个组织
+ id	int64	组织id
+ name	string	组织名称
+ parent_id	int64	父组织id

响应数据样例

json

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 9837366,
    "username": "testname",
    "real_name": "张三",
    "nickname": "大张伟",
    "gender": 1,
    "email": "test@qq.com",
    "phone": "15699999999",
    "department": "销售部",
    "avatar": "https://f-dev.clobotics.cn/4/0040ca4d85f5e5ef7354102f486ef843.jpg",
    "unique_code": "uuytr",
    "roles": [
      {
        "id": 1256,
        "name": "admin",
        "code": "admin",
        "system_id": 343,
        "order": 1,
        "description": "test"
      }
    ],
    "orgs": [
      {
        "id": 233,
        "parent_id": 3232,
        "name": "总部"
      }
    ]
  }
}

更新用户信息

接口说明

更新用户信息，字段全量更新，不支持修改部分字段。

请求信息

配置说明	参数值
URL	`/user`
Method	`PUT`
Content-Type	`application/json`

Body参数

参数名	类型	描述	是否必填
id	int64	用户id,id和用户名二选一必填	否
username	string	用户名，id和用户名二选一必填，用户名不做更新。	否
real_name	string	真实姓名，最长100位	否
password	string	用户明文密码，最长200位	否
nickname	string	昵称，最长100位	否
gender	int32	性别，`1`=男性，`2`=女性	否
email	string	邮箱	否
phone	string	手机号	否
department	string	部门	否
avatar	string	头像，最长250位	否
unique_code	string	用户唯一编码，最长50位	否

Body数据样例

json

{
  "id": 23,
  "username": "testname",
  "real_name": "张三",
  "password": "123456",
  "nickname": "大张伟",
  "gender": 1,
  "email": "test@qq.com",
  "phone": "15699999999",
  "department": "销售部",
  "avatar": "https://f-dev.clobotics.cn/4/0040ca4d85f5e5ef7354102f486ef843.jpg",
  "unique_code": "uuytr"
}

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

用户绑定角色

接口说明

用户角色绑定。角色相关请查看账户角色。

注意：

现阶段只支持一个用户绑定一个角色。

请求信息

配置说明	参数值
URL	`/user/role`
Method	`POST`
Content-Type	`application/json`

Body参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是
role_id	int64	角色id	是

Body数据样例

json

{
  "user_id": 23,
  "role_id": 232
}

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

查询用户角色

接口说明

查询用户绑定的角色列表

请求信息

配置说明	参数值
URL	`/user/role?user_id=12`
Method	`GET`

请求参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是

响应数据

`data`数据格式

参数名	类型	描述
user_id	int64	用户id
roles	[]object	角色列表
+ id	int64	角色id
+ name	string	角色名称
+ system_id	int64	系统id
+ order	int32	序号
+ description	string	描述

响应数据样例

json

{
  "code": 0,
  "message": "success",
  "data": {
    "user_id": 12,
    "roles": [
      {
        "id": 1256,
        "name": "admin",
        "system_id": 343,
        "order": 1,
        "description": "test"
      }
    ]
  }
}

用户解绑角色

接口说明

将用户和角色解绑。角色相关请查看账户角色。

请求信息

配置说明	参数值
URL	`/user/role?user_id=12&role_id=23`
Method	`DELETE`

请求参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是
role_id	int64	角色id	是

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

用户绑定组织

接口说明

用户组织绑定。组织相关请查看组织。

注意：

现阶段只支持一个用户绑定一个组织。

请求信息

配置说明	参数值
URL	`/user/org`
Method	`POST`
Content-Type	`application/json`

Body参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是
org_id	int64	组织id	是

Body数据样例

json

{
  "user_id": 23,
  "org_id": 232
}

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

用户解绑组织

接口说明

将用户和组织解绑。组织相关请查看组织。

请求信息

配置说明	参数值
URL	`/user/org?user_id=123&org_id=23`
Method	`DELETE`

请求参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是
org_id	int64	组织id	是

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

用户绑定门店

接口说明

用户门店绑定。门店相关请查看门店。

注意：

现阶段绑定是指业务代表绑定。

请求信息

配置说明	参数值
URL	`/user/store`
Method	`POST`
Content-Type	`application/json`

Body参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是
store_code	string	门店code	是

Body数据样例

json

{
  "user_id": 23,
  "store_code": "STORE_CODE"
}

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

用户解绑门店

接口说明

将用户和门店解绑。门店相关请查看门店。

请求信息

配置说明	参数值
URL	`/user/store?store_code=STORE_CODE&user_id=23`
Method	`DELETE`

请求参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是
store_code	string	门店code	是

响应数据

响应数据样例

json

{
  "code": 0,
  "message": "success"
}

查询用户绑定门店

接口说明

根据用户查询用户名下所有门店，现阶段指业务代表绑定的店。

请求信息

配置说明	参数值
URL	`/user/store?user_id=23`
Method	`GET`

请求参数

参数名	类型	描述	是否必填
user_id	int64	用户id	是

响应数据

`data`数据格式

参数名	类型	描述
stores	[]object	门店列表
+ code	string	门店code
+ name	string	门店名称
+ address	string	门店地址

响应数据样例

json

{
  "code": 0,
  "message": "success",
  "data": {
    "stores": [
      {
        "code": "STORE_CODE",
        "name": "汕头门店",
        "address": "广东省汕头市大寮区"
      }
    ]
  }
}

批量更新用户门店绑定关系

接口说明

批量更新门店绑定关系接口，同时支持创建用户和更新用户信息，已存在的用户和门店绑定关系会被新的绑定关系全量覆盖。

请求信息

配置说明	参数值
URL	`/user/stores`
Method	`POST`
Content-Type	`application/json`

Body参数

参数名	类型	描述	是否必填
username	string	用户名，登录时的账户名,最长50位	是
real_name	string	真实姓名，最长100位，不传则不更新该字段	否
password	string	用户密码，最长200位，不传则不更新该字段	否
phone	string	手机，不传则不更新该字段	否
department	string	部门，最长100位，不传则不更新该字段	否
ext_info	string	其他额外信息，最大长度1000。建议使用json格式字符串数据，如：{"lead_phone":"18888888888","lead_real_name":"王五","lead_username":"wangwu","area_manager":"张三"}	否
store_codes	[]string	门店编码列表，不传或传null则不更新绑定关系，传空数组则表示解绑用户下的所有门店，如果传了门店编码列表则会全量覆盖该用户的所有门店绑定关系，已有的绑定关系会被解除。门店需提前通过门店创建接口创建，否则会返回门店不存在的错误。已存在的用户和门店绑定关系会被新的关系覆盖。	否

Body数据样例

json

{
  "username": "testname",
  "real_name": "张三",
  "password": "123456",
  "phone": "15699999999",
  "department":"销售部",
  "ext_info":"{\"lead_phone\":\"18888888888\",\"lead_real_name\":\"王五\",\"lead_username\":\"wangwu\",\"area_manager\":\"张三\"}",
  "store_codes": ["TEST001","TEST002","TEST003"]
}

数据响应

`data`数据格式

参数名	类型	描述
id	int64	用户id
username	string	用户名，登录时的账户名

响应数据样例

json

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 9837366,
    "username": "testname"
  }
}

账户 ​

创建用户 ​

接口说明 ​

请求信息 ​

Body参数 ​

Body数据样例 ​

数据响应 ​

data数据格式 ​

响应数据样例 ​

查询用户 ​

接口说明 ​

请求信息 ​

请求参数 ​

响应数据 ​

data数据格式 ​

响应数据样例 ​

更新用户信息 ​

接口说明 ​

请求信息 ​

Body参数 ​

Body数据样例 ​

响应数据 ​

响应数据样例 ​

用户绑定角色 ​

接口说明 ​

请求信息 ​

Body参数 ​

Body数据样例 ​

响应数据 ​

响应数据样例 ​

查询用户角色 ​

接口说明 ​

请求信息 ​

请求参数 ​

响应数据 ​

data数据格式 ​

响应数据样例 ​

用户解绑角色 ​

接口说明 ​

请求信息 ​

请求参数 ​

响应数据 ​

响应数据样例 ​

用户绑定组织 ​

接口说明 ​

请求信息 ​

Body参数 ​

Body数据样例 ​

响应数据 ​

响应数据样例 ​

用户解绑组织 ​

接口说明 ​

请求信息 ​

请求参数 ​

响应数据 ​

响应数据样例 ​

用户绑定门店 ​

接口说明 ​

请求信息 ​

Body参数 ​

Body数据样例 ​

响应数据 ​

响应数据样例 ​

用户解绑门店 ​

接口说明 ​

请求信息 ​

请求参数 ​

响应数据 ​

响应数据样例 ​

查询用户绑定门店 ​

接口说明 ​

请求信息 ​

请求参数 ​

响应数据 ​

data数据格式 ​

响应数据样例 ​

批量更新用户门店绑定关系 ​

接口说明 ​

请求信息 ​

Body参数 ​

账户

创建用户

接口说明

请求信息

Body参数

Body数据样例

数据响应

`data`数据格式

响应数据样例

查询用户

接口说明

请求信息

请求参数

响应数据

`data`数据格式

响应数据样例

更新用户信息

接口说明

请求信息

Body参数

Body数据样例

响应数据

响应数据样例

用户绑定角色

接口说明

请求信息

Body参数

Body数据样例

响应数据

响应数据样例

查询用户角色

接口说明

请求信息

请求参数

响应数据

`data`数据格式

响应数据样例

用户解绑角色

接口说明

请求信息

请求参数

响应数据

响应数据样例

用户绑定组织

接口说明

请求信息

Body参数

Body数据样例

响应数据

响应数据样例

用户解绑组织

接口说明

请求信息

请求参数

响应数据

响应数据样例

用户绑定门店

接口说明

请求信息

Body参数

Body数据样例

响应数据

响应数据样例

用户解绑门店

接口说明

请求信息

请求参数

响应数据

响应数据样例

查询用户绑定门店

接口说明

请求信息

请求参数

响应数据

`data`数据格式

响应数据样例

批量更新用户门店绑定关系

接口说明

请求信息

Body参数