部门全量同步
接口说明
- 用户购买联营SaaS应用后,登录到华为云买家中心控制台,将应用与企业绑定时,云商店调用该接口请求商家同步该企业全量的组织信息,商家接口需要执行全量组织信息同步,保存组织信息,并返回通知云商店。
- 商家的服务器在处理接口请求时,需要做好幂等性处理。
对于同一个实例,相同的租户,相同的orgCode,要支持多次请求,多次请求不应产生新的数据,且需要返回成功。
请求方法:POST
接口URL:生产地址+固定子路径,其中固定子路径为/produceAPI/v2/allOrgSync;
接口示例:生产地址为https://example.isv.com,则接口URL为https://example.isv.com/produceAPI/v2/allOrgSync
BODY请求参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
instanceId |
M |
String(64) |
说明:
卖家申请应用凭证的时候传空,买家必传。 |
tenantId |
M |
String(64) |
租户ID |
orgInfoList |
M |
OrgInfo[] |
组织内部门层级信息,包含部门代码、部门名称、上级部门 请参考Orglnfo类型定义 |
testFlag |
M |
Integer(2) |
0-生产正式数据1-调测数据 |
timeStamp |
M |
String |
默认时区东8区,时间格式:20220420114117642 |
Orglnfo类型定义
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
orgCode |
M |
String(64) |
部门代码 |
orgName |
M |
String(128) |
部门名称 |
parentCode |
O |
String(64) |
上级部门,顶级部门的上级部门为空 |
响应参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
resultCode |
M |
String(6) |
响应码, 具体请参见调用结果码说明。 |
resultMsg |
O |
String(255) |
响应信息 |
示例:
请求示例: POST https://example.isv.com/produceAPI/v2/allOrgSync Content-Type: application/json x-sign: 11C4CD6279191DE931DEF5C51531DFFA9D37969F4E356B8A3A6D8DE4FB357A48 x-timestamp: 1680508066618 x-nonce:50D83FDECAED6CCD8EF597F2A577950527928BA287D04E6036E92B2806FD17DA {"instanceId": "hua******t123456","tenantId": "68cbc8******b880d92f36422fa0e","orgInfoList": "[{orgCode:\"00000001\", orgName:\"产品部\", parentCode:\"265789314\" },{orgCode:\"00000002\", orgName:\"测试部\", parentCode:\"265789314\" }]","flag": 1,"testFlag": 0,"timeStamp": "20220413093539534"} 响应示例: HTTP/1.1 200 OK Content-Type: application/json { " resultCode": "000000", " resultMsg": "Success" }