# 数据同步2024.2+

支持用户将自己系统中的用户、用户组，同步到河图系统中的团队下。

# 同步配置

管理团队下的同步密钥。

全局样式

密钥： 同步请求时用于身份识别。需要将该密钥放到Header中，Key为SECRET。
状态： 控制当前配置是否可用，如果停用则不能通过该密钥再同步数据。

# 同步日志

记录团队下的所有同步请求。

全局样式

请求ID： 每次同步请求，会生成一个唯一请求ID。。
同步类型： 用户、用户组。
请求操作： 保存、删除。
同步结果： 同步的数据是否全部成功。

# 同步详情

查看同步日志中，同步结果为失败的详细信息。

全局样式

标识： 同步类型为用户时是登录名，同步类型为用户组时是用户组名称。
错误信息： 同步失败原因。

# 同步数据

# 用户同步

支持用户将自己系统中的用户，作为团队用户，同步到团队下。

# 保存

该接口支持，通过登录名新增和修改用户信息。同时支持将用户添加和移出用户组。

# 基本信息

请求方式： POST

请求地址： 河图地址/hetu/team/sync/member

Body参数

属性	类型	必填	示例值	描述
fullName	String	否	小明	昵称，长度最大30个字符。
loginName	String	是	wuli	数字、字母、下划线组成，长度最大50个字符，同一团队登录名不能重复。
cellphone	String	否	177********	符合手机号规则，同一团队手机号不能重复。
password	String	否	123456	密码，password需要是明文。如果同步用户时没有密码，只能通过单点登录登录。
email	String	否	test@xxx.com	符合邮箱规则，长度最大100个字符，同一团队邮箱不能重复。
city	String	否	北京	城市，长度最大200个字符。
birthDate	String	否	2022-03-04	生日，长度最大20个字符。
occupation	String	否	医生	职业，长度最大50个字符。
company	String	否	太极	公司名称，长度最大50个字符。
summary	String	否	简介	简介，长度最大500个字符。
groupNames	String[]	否		用户组名称数组，用户组名称不能为空，长度最大100个字符。

# 请求示例

curl --request POST \
  --url  `河图地址`/hetu/team/sync/member \
  --header 'SECRET: ZTk4YmMzZDA3NF9USloxVERWQ0hC' \
  --header 'content-type: application/json' \
  --data '[
    {
        "fullName":"蓝天",
        "loginName":"test",
        "cellphone":"17715444894",
        "password":"123123",
        "email":"125547896@qq.com",
        "city":"北京",
        "birthDate":"2022-03-04",
        "occupation":"医生",
        "company":"太极",
        "summary":"简介",
        "groupNames":["用户组名称"]
    }
]'

提示：

用户所在的用户组，groupNames需要传全量数据。
groupNames里面的用户组名称在团队下不存在，则自动创建用户组。

# 删除

该接口支持，通过登录名批量删除用户。

# 基本信息

请求方式： POST

请求地址： 河图地址/hetu/team/sync/delete/member

Body参数

属性	类型	必填	示例值	描述
loginNames	String[]	是	wuli	loginName不能为空，长度最大50个字符

# 请求示例

curl --request DELETE \
  --url  `河图地址`/hetu/team/sync/delete/member \
  --header 'SECRET: ZTk4YmMzZDA3NF9USloxVERWQ0hC' \
  --header 'content-type: application/json' \
  --data '{
  "loginNames": [
    "wulei",
    "xiaoming"
  ]
}'

# 用户组同步

用户可以将自己系统中的用户组，同步到团队下。

# 保存

该接口支持，通过用户组名称新增和修改用户组信息。

# 基本信息

请求方式： POST

请求地址： 河图地址/hetu/team/sync/member

Body参数

名称	类型	必填	示例值	描述
groupName	String	是	人事	用户组名称，不能为空，长度最大100个字符。
orderNo	Number	否	1	排序号。
remark	String	否	研发人员使用	备注，长度最大200个字符。

# 请求示例

curl --request POST \
  --url  `河图地址`/hetu/team/sync/group \
  --header 'SECRET: ZTk4YmMzZDA3NF9USloxVERWQ0hC' \
  --header 'content-type: application/json' \
  --data '[
      {
        "groupName": "研发组",
        "orderNo": 1,
        "remark": "研发人员使用"
      }
]'

# 删除

该接口支持，通过用户组名称批量删除用户组。

# 基本信息

请求方式： POST

请求地址： 河图地址/hetu/team/sync/delete/group

Body参数

属性	类型	必填	示例值	描述
groupNames	String[]	是	人事	groupName不能为空，长度最大100个字符。

# 请求示例

curl --request DELETE \
  --url  `河图地址`/hetu/team/sync/delete/group \
  --header 'SECRET: ZTk4YmMzZDA3NF9USloxVERWQ0hC' \
  --header 'content-type: application/json' \
  --data '{
  "groupNames": [
    "研发人员"
  ]
}'

# 返回

# 返回参数

名称	类型	示例值	描述
message	String	操作成功	返回消息。
code	Number	200	状态码。
data	Object		返回数据。
requestId	String	1707032327700979866	请求ID。
status	String	success	返回状态：success，error。

提示：

每次同步请求都生成一个全局唯一的请求ID并返回，可以通过请求ID，查询同步日志和系统日志。

# 成功示例

{
  "message": "操作成功",
  "code": 200,
  "data": {
    "requestId": "1707032327700979866"
  },
  "status": "success"
}

# 失败示例

{
  "message": "错误信息",
  "code": 200,
  "data": {
    "requestId": "1707039581118283831"
  },
  "status": "error"
}

← 用户组管理权限矩阵 →