文档中心 云市场 云市场API 接口描述 新购资源

新购资源

最近更新时间:2020-07-09 15:53:36

客户购买商品并付款成功后,云市场将调用本接口通知服务商客户所购买商品的信息和客户信息,服务商收到该请求信息,需创建资源并将执行结果返回给云市场。需要返回对应订单开通的实例Id(instanceId)和结果。后续续费、关停、过期等操作云市场会使用此标识。建议使用bizId作为实例id,以确保instanceId的唯一性。instanceId 最少24 个字符,最多 64 个字符。

请不要阻塞此接口,如果耗时较长(处理时长超过10秒),建议使用队列做缓冲处理,设置instanceId=0,然后立即返回。若操作失败也请设置instanceId=0,云市场会再次调用,直到获取到instanceId。若资源开通失败,平台会自动退款给客户。

新购资源时,服务商在处理接口时,需要做好幂等性处理,可用订单ID作为幂等标识。针对同一订单号,应当返回成功的响应及实例信息,不应该创建新的SaaS实例,返回之前成功创建的实例信息即可。

新购的流程图如下:

image.png

接口说明:

参数名称 是否必须 类型 最大字符长度 说明
accessKey 是 String 50 accessKey
action 是 String 20 固定值:createInstance
timestamp 是 String 20 请求发起的时间请求发起的时间
requestId 是 String 40 请求ID
version 是 String 10 API版本号
testFlag 是 Integer 2 是否为调试请求
signature 是 String 120 接口签名结果串
userId 是 Long 18 客户在金山云的账号唯一标识
productId 是 Long 18 云市场产品ID
productInfo 否 JSON 2048 商品描述信息自定义的key-value数据。
如:
{
“packageName”: “门店版”,
“productName”: “CRM1.0”
}
orderId 是 String 64 订单ID,可作为本接口幂等标识
bizId 是 String 64 云市场业务ID。建议使用bizId作为实例id,以确保 instanceId的唯一性
trialFlag 是 Integer 2 是否开通试用实例1:试用实例0:非试用实例
packageCode 是 String 64 产品规格标识,服务商商品接入时由服务商指定,建议服务处全局唯一
extendParams 否 JSON 2048 扩展参数,开通实例时,ISV要收集的信息。JSON的key和value均为String。key为 phone或 email 时,对应的 value 是经过加密后进行传输的。加密方式参考敏感信息加密传输章节。
如:{
“phone”:“61610cYx0379YAk1YfL38wJ5zHIuiLm5rVMjRg==”,
“companyName”:“testCompanyName”,
“userName”:“ksyun-user”,
“email”:“zHwh8Zp8rU8pSiAsQ52c4E9u/ICvEOUZZa9Xnw==”}
extraBillParams 否 JSON 2048 额外计费项和价格影响因子如:
{
“app”:“ios”,
“accountNum”:“1”,
“region”:“北京”
}
serviceEndTime 否 DateTime 20 服务到期的时间,格式:yyyyMMddHHmmss按次购买的产品不会请求该参数

请考虑后续增加新字段的兼容性

响应参数说明:

参数名称 是否必须 类型 最大字符长度 说明
result 是 String 6 调用结果码
resultMsg 否 String 255 调用结果描述
instanceId 是 String 64 实例ID,服务商提供的唯一标识
appInfo 是 固定JSON SaaS服务的使用信息
additionalInfo 否 JSON 2048 自定义的key-value数据,会显示在实例详情中。格式为[{“key”:"",“value”:""}]如:
[
{
“key”: “additionInfo1”,
“value”: “additionInfoValue1”
},
{ “key”: “additionInfo2”,
“value”: “additionInfoValue2”
}
]

appInfo的数据结构

参数名称 是否必须 类型 最大字符长度 说明
frontEndUrl 是 String 512 客户购买后,可以访问的前台地址
adminUrl 否 String 512 客户购买后,可以访问的管理后台地址
authUrl 否 String 512 免登地址
userName 否 String 128 加密后的管理员账号名,加密方式参考敏感信息加密传输章节。
password 否 String 128 加密后的管理员登录密码,加密方式参考敏感信息加密传输章节。
ip 否 String 64 网站的IP
memo 否 String 512 备注,如简要使用说明。
上一篇:接口描述
下一篇:续费资源
以上内容是否对您有帮助?
有帮助
没帮助