组织部门信息同步(全量)
接口说明
- 买家购买联营SaaS应用后,在买家中心登录,将应用与企业绑定时,云商店调用该接口请求商家同步该企业全量的组织信息,商家接口需要执行全量组织信息同步,保存组织信息,并返回通知云商店。
- 商家的服务器在处理接口请求时,需要做好幂等性处理。
对于同一个实例,相同的租户,相同的orgCode,要支持多次请求,多次请求不应产生新的数据,且需要返回成功。
请求方法:POST
接口URL:生产地址+固定子路径,其中固定子路径为/produceAPI/allOrgSync;
接口示例:生产地址为https://example.isv.com,则接口URL为https://example.isv.com/produceAPI/allOrgSync
Headers请参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
authToken |
M |
String(255) |
签名信息,请参考auth Token取值说明。 |
BODY请求参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
instanceId |
M |
String(64) |
说明:
卖家申请应用凭证的时候传空,买家必传。 |
tenantId |
M |
String(64) |
租户ID |
orgInfo |
M |
String |
组织内部门层级信息,包含部门代码、部门名称、上级部门Code,Json串,非树形结构 JSON串,例: [{\"orgCode\":\"00000001\", \"name\":\"产品部\",\"parentCode\":\"265789314\"},{\"orgCode\":\"00000002\", \"name\":\"测试部\",\"parentCode\":\"265789314\"}] |
testFlag |
M |
Integer(2) |
0-生产正式数据 1-调测数据 |
timeStamp |
M |
String |
默认时区东8区,时间戳,时间格式:20220420114117642 |
响应参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
resultCode |
M |
String(6) |
响应码,具体请参见调用结果码说明。 |
resultMsg |
O |
String(255) |
响应信息 |
示例:
POST https://example.isv.com/produceAPI/allOrgSync Connection: keep-alive Content-Type: application/json authToken: "stbNYluH*********Dr6WDAVLtLRb” Host: example.isv.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "instanceId": "hua******t123456", "tenantId": "68cbc8******b880d92f36422fa0e", "orgInfo": "[{orgCode:\"00000001\", name:\"产品部\", parentCode:\"265789314\" },{orgCode:\"00000002\", name:\"测试部\", parentCode:\"265789314\" }]", "flag": 1, "testFlag": 0, "timeStamp": "20220413093539534" , } HTTP/1.1 200 OK Body-Sign: sign_type="HMAC-SHA256", signature= "xxxxxxxxxx" Content-Type: application/json { " resultCode": "000000", " resultMsg": "Success" }
HTTP Body签名:
Body-Sign: sign_type="HMAC-SHA256", signature= "xxxxxxxxxxxxx" ,详情参考《HTTP Body签名》。