组织部门信息同步(增量)
接口说明
- 管理员被授权管理某企业后,在买家中心登录,对管理的企业执行新建、编辑、删除部门操作时,云商店调用该接口,请求商家同步该企业的组织增量变更;商家接口需要执行增量组织信息同步,保存信息,并返回通知云商店。
- 商家的服务器在处理接口请求时,需要做好幂等性处理。
对于同一个实例,相同的租户,相同的orgCode,要支持多次请求新增,或者删除,多次新增不应产生新的数据,且需要返回成功,如果是删除,多次删除也需要返回成功,不能因已删除返回失败,删除时不需要校验(新购商品)接口产生的实例是否存在。
请求方法:POST
接口URL:生产地址+固定子路径,其中固定子路径为/produceAPI/singleOrgSync;
接口示例:生产地址为https://example.isv.com,则接口URL为https://example.isv.com/produceAPI/singleOrgSync
Headers请参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
authToken |
M |
String(255) |
签名信息,请参考auth Token取值说明。 |
BODY请求参数
参数 |
必选 |
参数类型 |
描述 |
---|---|---|---|
instanceId |
M |
String(64) |
说明:
卖家申请应用凭证的时候传空,买家必传。 |
tenantId |
M |
String(64) |
租户ID,与租户的同步信息保持一致 |
orgCode |
M |
String(64) |
部门代码 租户自定义,租户内唯一 |
orgName |
M |
Vachar(128) |
部门名称 所在层级唯一,允许租户更新名称 |
parentCode |
O |
String(64) |
上级部门的orgCode,如果是顶层部门,这个值为空,其他场景不能为空,允许租户更新当前部门归属的上层部门 |
flag |
M |
Integer(2) |
0-删除 1-新增,2-修改 |
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/singleOrgSync Connection: keep-alive Content-Type: application/json authToken: "stbNYlu**************2Ubt271qDr6WDAVLtLRb” Host: example.isv.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "instanceId": "hua********23456", "instanceId": "hua********23456", "tenantId": "68cbc********0d92f36422fa0e", "orgCode": "10000", "orgName": "开发部", "parentCode": "", "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签名》。