创建实例
接口说明
客户购买商品并付款成功,云商店将调用本接口通知商家创建实例。
- 商家需要返回此订单的唯一ID(instanceId)。建议此ID直接使用该订单首次请求时云商店传入的businessId,以确保instanceId的唯一性。
- 在正常购买场景中,请不要阻塞此接口,如果耗时较长,建议异步创建实例,可以先生成instanceId,然后立即返回。云商店后续会通过查询实例信息接口查询实例开通结果。
- 如涉及按需、按需套餐包商品,需要对接按需使用量推送(新)。
- 获取订单信息,请参考查询订单。
云商店服务有可能重发请求,针对同一订单号(orderId)和订单行(orderLineId),商家的服务器应当返回相同的instanceId,不应该创建新的SaaS实例,返回之前成功创建的实例信息即可。
按需交易场景,需要基于订单号(orderId)和产品标识(productId)构建幂等。
创建实例流程如下图所示:
请求消息
请求参数说明请参见下表。云商店会结合商家创建上架的商品售卖模式来对应请求,商家也需要根据请求的信息来对应执行生产。
请求方式:POST
Body参数
参数 |
是否必选 |
参数类型 |
最大字符长度 |
说明 |
---|---|---|---|---|
activity |
M |
String |
20 |
接口请求标识,用于区分接口请求场景。 新购场景取值:newInstance |
orderId |
M |
String |
64 |
云商店订单ID。 |
orderLineId |
M |
String |
64 |
云商店订单行ID。 |
businessId |
M |
String |
64 |
云商店业务ID。 每一次请求,businessId皆不一致。 |
testFlag |
O |
String |
2 |
是否为调试请求。
默认取值为“0”。 |
请求消息示例:
curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=11C4CD6279191DE931DEF5C51531DFFA9D37969F4E356B8A3A6D8DE4FB357A48×tamp=1680508066618&nonce=50D83FDECAED6CCD8EF597F2A577950527928BA287D04E6036E92B2806FD17DA' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"newInstance","businessId":"87b94795-0603-4e24-8ae5-69420d60e3c8","orderId":"CS2211181819B4LVS","orderLineId":"CS2211181819B4LVS-000001","testFlag":"0"}'
响应消息
响应参数说明请参见下表:
参数 |
是否必选 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|---|
resultCode |
M |
String |
6 |
调用结果码。
具体请参见调用结果码说明。
说明:
如果创建实例耗时较长,建议返回0000004,云商店后续会通过查询实例信息接口查询实例开通结果。 |
resultMsg |
O |
String |
255 |
调用结果描述。 |
instanceId |
M |
String |
64 |
云商店业务ID。 |
响应消息示例:
{ "resultCode":"000000", "resultMsg":"success." , "instanceId":"03pf80c2bae96vc49b80b917bea776d7" }