文档首页/ 云商店/ 接入指南/ SaaS类商品接入指南V2.0（新商品上架）/ 基础接口描述/ 更新实例
更新时间：2024-06-12 GMT+08:00
查看PDF
分享

更新实例

接口说明

按周期售卖的商品，用户试用转正、续费、退续费后，云商店调用该接口，更新实例的到期日期。

  • 用户进行商品转正、续费下单或退订续费周期后，云商店将调用该接口请求商家执行业务变更，商家接口需要执行将到期日进行更新，并返回通知云商店。
  • 商家需要保障更新实例接口通畅，如调用失败，将可能导致用户的业务被释放的风险。
  • 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。
  • 云商店会对接口异常的情况做监控，如SaaS商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。

商品更新实例流程如下图所示：

请求消息

请求参数说明请参见下表：

请求方法：POST

Body参数

参数

是否必选

类型

取值范围

说明

activity

M

String

20

接口请求标识，用于区分接口请求场景。

续费场景取值：refreshInstance

scene

M

String

64

场景，触发实例变更的场景：

TRIAL_TO_FORMAL：试用转正

RENEWAL：续费

UNSUBSCRIBE_RENEWAL_PERIOD：退续费

orderId

M

String

64

云商店订单ID，

试用转正时传递转正订单ID

续费时传递当前续费订单ID

退续费时传递退续费订单ID

orderLineId

M

String

64

云商店订单行ID。

instanceId

M

String

64

实例ID。

productId

O

String

64

产品标识，租户续费或转正产品实例时，如果订购周期类型发生变化，会传入变化后的产品类型对应的productId。

expireTime

M

String

20

过期时间。

格式：yyyyMMddHHmmss

testFlag

O

String

2

是否为调试请求。

  • 1：调试请求
  • 0：非调试请求

默认取值为“0”。

请求消息示例：

curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=3F6E6652B7BE26B27ABFC3D11214D04BFD8D2CF8AC21603D85620174FE8DE062&timestamp=1680509496350&nonce=8BF8496A350E37BDB0E8956D39D433ED417C3FC9459DCFFE7F03BFBF69B12085' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"refreshInstance","expireTime":"20221124023618256","instanceId":"10e758d0-31ad-4c4b-8f1b-81d03469a10e","orderId":"CS2211181819B4LVS","orderLineId":"CS2211181819B4LVS-000001","productId":"OFFI461867333479178240","scene":"RENEWAL","testFlag":"0"}'

响应参数说明请参见下表：

参数

是否必选

类型

取值范围

说明

resultCode

M

String

6

调用结果码。

具体请参见调用结果码说明。

resultMsg

O

String

255

调用结果描述。

响应消息示例：

{ 
    "resultCode":"000000", 
    "resultMsg":"success." 
}
父主题： 基础接口描述