更新时间:2024-02-20 GMT+08:00
分享

租户信息同步接口

接口说明

  • 买家购买联营SaaS商品后,在买家中心登录,将应用与企业绑定时,云商店调用该接口请求商家同步该企业的租户信息,商家接口需要执行租户同步,保存租户信息,并返回通知云商店。
  • 针对租户同步场景接口调用失败的情况,由买家选择是否重试,并用短信或邮件的形式通知商家接口调用失败。
  • 商家的服务器在处理接口请求时,需要做好幂等性处理。

    对于同一个实例,相同的租户要支持多次请求新增,或者删除,多次新增不应产生新的数据,且需要返回成功,如果是删除,多次删除也需要返回成功,不能因已删除返回失败,删除时不需要校验(新购商品)接口产生的实例是否存在。

租户同步流程如下图所示:

请求方法:POST

接口URL:生产地址+固定子路径,其中固定子路径为/produceAPI/tenantSync;

接口示例:生产地址为https://example.isv.com,则接口URL为https://example.isv.com/produceAPI/tenantSync

Headers请参数

参数

必选

参数类型

描述

authToken

M

String(255)

签名信息,请参考auth Token取值说明

Body参数

参数

必选

参数类型

描述

instanceId

M

String(64)

说明:

实例ID,卖家申请应用凭证的时候传空,买家正式订单必传。

orderId

M

String(64)

说明:

买家的订单号,卖家申请应用凭证的时候传空,买家正式订单必传。

tenantId

M

String(64)

租户ID

tenantCode

M

String(64)

租户标识,用来识别最终用户的登录指向买家对应的域名

name

M

String(255)

租户名称,买家企业的名称

domainName

M

String(255)

域名,是认证中心返回的统一域名地址

flag

M

Integer(2)

0-删除 1-新增

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/tenantSync */produceAPI/tenantSync为固定值/*
Connection: keep-alive
Content-Type: application/json
authToken: "stb****************HvordsmyF2Ubt271qDr6WDAVLtLRb”
Host: example.isv.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "instanceId": "huaiweitest123456", 
 "orderId": "CS1906666666ABCDE", 
 "tenantId": "68cbc86****************880d92f36422fa0e", 
 "tenantCode": "huawei", 
 "name": "huaiweitest", 
 "domainName": "https://example.tenantaccount.com", 
 "flag": 1, 
 "testFlag": 0, 
 "timeStamp": "20220413093539534", 
}

HTTP/1.1 200 OK
Body-Sign: sign_type="HMAC-SHA256", signature= "******"  
Content-Type: application/json
{
" resultCode": "000000",
" resultMsg": "Success"
}

HTTP Body签名:

Body-Sign: sign_type="HMAC-SHA256", signature= "******" ,详情参考《HTTP Body签名》

相关文档