SaaS类商品接入示例工程
引导式阅读
Java
SaaS类商品接入示例工程
作者
C***
上架时间
2022-08-03 12:50:25

0. 版本说明

不涉及SDK

1. 示例简介

>基于Spring boot构建,可以直接启动,通过修改application.properties配置文件里的server.port可以改变启动端口号, 默认访问路径为:http://127.0.0.1:8080/isv/produce?activity=newInstance&xxx ,可以通过卖家中心的应用工具菜单下的应用接入调试页面生成链接用来本地调试

新购商品

  • 1.客户购买商品并付款成功,云市场将调用本接口通知服务商客户购买商品的信息和客户信息,服务商收到该请求信息,需执行新购对应动作并将执行结果返回给云市场。

  • 2.服务商需要返回此订单对应的唯一实例ID(instanceId),对不同的新购订单实例ID(instanceId)不可一致。建议此ID直接使用该订单首次请求时云市场传入的businessId,以确保instanceId的唯一性。

  • 3.当接口响应失败时,系统会邮件通知到服务商云市场账号绑定的邮箱,生产接口消息中可查询接口“异常信息”,服务商收到通知后须尽快处理接口异常,避免订单失败退订。 针对新购场景接口调用失败的情况,云市场会持续调用3小时(每小时1次)后停止调用,期间服务商可在“卖家中心>生产接口消息”页面单击对应接口右侧操作栏的“重新启动”进行手动重试。若服务商接口问题在3小时调用时间内解决,则在下一次调用接口响应成功,订单开通成功;若服务商接口问题在3小时调用后仍未解决,系统则判断订单为失败,并自动进行订单退订。若商品单月因接口失败导致的失败订单超过5个,云市场将对该商品下架处理。

  • 4.服务商的服务器在处理接口请求时,需要做好幂等性处理。 云市场服务有可能重发请求,针对同一订单号,服务商的服务器应当返回成功的响应及应用实例信息,不应该创建新的SaaS实例,返回之前成功创建的实例信息即可。

商品续费

  • 1.按周期售卖的商品,服务商必须实现续费接口生产开发。

  • 2.客户续费下单或试用商品转正后,云市场将调用该接口请求服务商执行业务延期,服务商接口需要执行将到期日进行更新,并返回通知云市场。

  • 3.服务商需要保障续费接口通畅,将业务进行延期,如续费失败,将可能导致用户的业务被释放的风险。

  • 4.针对续费场景接口调用失败的情况,云市场会调用1次,“卖家中心—生产接口消息”中可查询接口“异常信息”,请在修复接口异常后,通知云市场对该失败调用进行重新调用。

商品过期

  • 1.客户购买的商品过期时,云市场调用该接口,服务商接到该通知以后应该将指定的实例冻结。

  • 2.针对过期场景接口调用失败的情况,云市场会持续调用到60次(每1分钟1次)后停止调用,“卖家中心—生产接口消息”中可查询接口“异常信息”。若服务商接口问题在60次调用时间内解决,则在下一次调用时接口响应成功;若服务商接口问题在60次调用后仍无解决,系统停止调用,请在修复接口异常后,在“卖家中心—生产接口消息”该订单记录的右侧点击“重新启动”,进行接口的重新调用。

商品资源释放

  • 1.云市场将在释放客户购买的商品时调用该接口,服务商接收到该通知以后可以删除指定的实例。

  • 2.当客户已购买的商品到期不续订且超过保留期、或申请退订商品成功时,将释放客户购买的商品资源。

  • 3.针对释放场景接口调用失败的情况,云市场会持续调用到60次(每1分钟1次)后停止调用,“卖家中心—生产接口消息”中可查询接口“异常信息”。若服务商接口问题在60次调用时间内解决,则在下一次调用时接口响应成功;若服务商接口问题在60次调用后仍无解决,系统停止调用,请在修复接口异常后,在“卖家中心—生产接口消息”该订单记录的右侧点击“重新启动”,进行接口的重新调用。

商品升级

  • 1.用户对已购买的商品进行升级,升级订单付款成功后,云市场调用该接口请求服务商升级用户购买的商品,服务商接口需要执行商品升级,并返回通知云市场。

  • 2.商品升级规则设置参考通用商品升级

2. 发布联营saas类商品或者通用saas类商品关联应用凭证的新增以下5个接口

租户同步

  • 卖家申请应用凭证,或者买家购买关联应用凭证的SaaS商品后,在买家中心将应用与企业绑定时,云市场调用该接口请求服务商同步该企业的租户信息,服务商接口需要执行租户同步,保存租户信息,并返回通知云市场。

应用同步

  • 卖家申请应用凭证,或者买家购买关联应用凭证的SaaS商品后,在买家中心将应用与企业绑定时,云市场调用该接口请求服务商同步该企业应用的认证信息,服务商接口需要执行应用同步,保存应用信息,并返回通知云市场。

应用授权

  • 管理员被授权管理某企业后,在买家中心对企业内用户授权该企业已绑定的应用,云市场异步调用该接口请求服务商同步该企业应用的用户授权信息,服务商接口需要执行授权信息同步,保存用户授权信息,并返回通知云市场。

组织部门信息同步(增量)

  • 管理员被授权管理某企业后,在买家中心对管理的企业执行新建、编辑、删除部门操作时,云市场调用该接口,请求服务商同步该企业的组织增量变更;服务商接口需要执行增量组织信息同步,保存信息,并返回通知云市场。

组织部门信息同步(全量)

  • 卖家申请应用凭证,或者买家购买关联应用凭证的SaaS商品后,在买家中心将应用与企业绑定时,云市场调用该接口请求服务商同步该企业全量的组织信息,服务商接口需要执行全量组织信息同步,保存组织信息,并返回通知云市场。

3. 参考

  • SaaS类商品接入流程介绍参考:https://support.huaweicloud.com/accessg-marketplace/zh-cn_topic_0070649060.html

  • 联营SaaS类商品接入指南参考:https://support.huaweicloud.com/accessg-marketplace/zh-cn_topic_0070649101.html

4. 修订记录

发布日期 文档版本 修订说明
2021-5-24 1.0 初始化示例工程
2021-7-14 1.1 升配接口同时支持GET和POST请求
2021-11-4 1.2 根据用户反馈调整示例代码函数命名以及参数顺序
2022-05-11 1.3 增加联营saas类商品的5个数据同步接口示例
2022-05-27 1.4 对租户同步,应用授权接口请求参数调整,对post body类型请求的参数签名验证示例修正,文档说明做部分修改
2022-06-17 1.5 失败场景的响应结果增加了响应签名
2022-07-05 1.6 对数据同步的接口描述进行补充