Microsoft Word - 阿里云市场ISV接入文档 (修改版).docx

Size: px

Start display at page:

Download "Microsoft Word - 阿里云市场ISV接入文档 (修改版).docx"

双衡
5 years ago
Views:

1 阿里云市场 ISV 接入文档 1.4

2 目录 1.1 简介适用对象前期准备接口描述新购商品商品续费商品过期释放商品资源绑定域名免登接口接口调试实际案例展示

3 文档版本纪录 : 版本号修改时间修改内容责任人年 1 月 13 日增加安全 &key 中调用南乡接口的编码逻辑, 增加参数 skuid 的描述年 6 月 17 日优化文档内容, 增加对重原方要字段的解释增加图例的展示 2

4 1.1 简介本文档描述了第三方应用接入到阿里云市场需要实现的接口定义, 当客户在阿里云市场购买商品后, 阿里云市场会将购买者购买商品的信息以及账号信息, 通过调用本文档中提供的接口, 发送给服务商服务商即可获得商品订购续费过期停用等信息同时服务商根据该信息对购买者信息进行处理文档中涉及到的所有接口都以 HTTP GET 方式调用, 消息传输以 JSON 格式 1.2 适用对象在线应用类的软件, 一般有独立可访问的网站地址, 客户无需购买独立的云资源, 可以通过互联网在网站进行注册登录操作功能等商品接入类型选择应用软件类 : 1.3 前期准备 1. Key 值获取 : 在服务商管理后台 (msp.aliyun.com) 概览页面获取 2. token 值 1) 说明 :token 值作为云市场与服务商之间进行安全校验必有参数, 云市场每次调用服务商接口的参数中都会带有 token 值服务商根据生成规则生成 token 值, 并与接口中获取的 token 值进行比较完全相同即为校验通过 2) 生成规则 : 取所有的 http get 请求参数 ( 排除 token), 对参数名进行字典排序, 在字符串的 3

5 最后加上你的 key, 然后对整个字符串进行 md5 加密 3) 举例 : ü 服务商收到的调用请求数据示例 : ü ü sort(p1,p2,p3); 不要加入 token token 生成 : p1=1&p2=2&p3=3&key=isvkey.tomd5() 1.4 接口描述新购商品描述客户购买商品并付款成功, 云市场将调用本接口通知服务商客户购买商品的信息和客户信息服务商需要返回此订单的唯一 ID(instanceId) 建议此 ID 直接使用云市场传入的 orderbizid 请不要阻塞此接口, 若耗时较长, 可使用队列做缓冲, 设置 instanceid=0, 然后立即返回若操作失败也请设置 instanceid=0, 云市场都会再次调用, 直到获取到 instanceid 该接口可能会被多次调用, 如果被重复调用, 请保证接口的幂等性请求参数 token true String 安全校验令牌 action true String createinstance aliuid true String 客户唯一标识 orderbizid true String 云市场业务 ID orderid true String 云市场订单 ID skuid true String 商品规格标识, 与商品唯一对应, 可在商品管理 4

6 的销售信息中查看例如 : Yuncode 客户在新购商品时, 会选择一个商品规格进行购买 accountquantity false Int 帐号数量, 适用于以帐号数量形式售卖的商品 expiredon false DateTime 过期时间 (yyyy-mm-dd HH:mm:ss) template false String 模板 ID, 适用于模板类建站商品 corpid false String 钉钉企业 ID, 适用于钉钉类商品 false String 客户邮箱 : 服务商创建商品时, 勾选需要客户授权 - 邮箱 mobile false String 客户手机 : 服务商创建商品时, 勾选需要客户授权 - 手机返回参数注 :hostinfo 字段是服务商在云市场开通了虚拟主机时使用选填字段 appinfo 字段是客户购买商品后, 登录服务地址 ( 网站地址 ) 进行后续操作, 或者实现客户免登 ( 需要返回免登地址 ) Info 字段是当 appinfo 无法满足服务商特殊登录要求时, 可以自定义 key-value 字段, 以提供给客户新购商品后的操作方法 instanceid true String 实例 ID, 服务商提供的唯一标识 hostinfo false 固定 JSON Key 名称说明 name 主机名 ip 服务器 ip innerip 服务器内网 ip username 服务器帐号 password 服务器密码 cname 服务器 CNAME 5

7 tempdomain 临时域名 ftpusername ftp 客户名 ftppassword ftp 密码 region 机房信息 beianinfo 备案地址 databaseinfo 数据库信息 appinfo false 固定 JSON Key 名称说明 frontendurl 前台地址 : 客户购买商品后, 可以访问的网站地址 adminurl 管理地址 : 客户购买商品后, 可以访问的管理后台地址 username 管理员帐号 : 客户购买商品后, 访问服务商管理后台的账号 : 一般为邮箱和手机号 password 管理员密码 : 客户购买商品后, 访问服务商管理后台的密码 : 一般为服务商生成 authurl 免登地址 : 服务商提供给客户的免登陆地址 info false JSON 自定义 Key-Value 数据请求示例 token=097a56e26a93c874140bbcdf403f3f60&action=createinstance&aliui d= &orderid=100001&orderbizid=1&skuid=sku 返回示例 { "instanceid": "1", "hostinfo": { 6

8 "name": "linux server", "ip": " ", "username": "root", "password": "root_password" }, "appinfo": { "frontendurl": " "adminurl": " "username": "admin", "password": "admin_password" }, "info": { "key1": "my custom info" } } 商品续费描述云市场将在客户续费后将调用该接口, 服务商需要将自己维护的到期日进行更新请求参数 action true String renewinstance instanceid true String 实例 ID expiredon true DateTime 过期时间 (yyyy-mm-dd HH:mm:ss) token true String 安全校验令牌返回参数 success true Boolean 是否成功 7

9 请求示例 ction=renewinstance&instanceid=1&expiredon= :01: 返回示例 { success : true } 商品过期描述云市场将客户购买的商品过期时调用该接口, 服务商接到该通知以后应该将制定的实例冻结请求参数 action true String expiredinstance instanceid true String 实例 ID token true String 安全校验令牌返回参数 success true Boolean 是否成功请求示例 &action=expiredinstance&instanceid= 返回示例 8

10 { success : true } 释放商品资源描述云市场将在释放客户购买的商品时调用该接口, 服务商接收到该通知以后可以删除指定的实例当前默认客户购买商品过期后 7 日内, 客户不进行续费等操作, 将释放客户购买的商品资源请求参数 action true String releaseinstance instanceid true String 实例 ID token true String 安全校验令牌返回参数参数必选类型及范围说明 success true Boolean 是否成功请求示例 action=releaseinstance&instanceid= 返回示例 { success : true } 绑定域名描述 9

11 云市场在客户绑定域名时调用该接口请求参数 action true String binddomain instanceid true String 实例 ID domains true String 以逗号隔开的域名字符串 token true String 安全校验令牌返回参数 Success true Boolean 是否成功请求示例 action=binddomain&instanceid=1&domains=yourdomain.com 返回示例 { success : true } 免登接口描述云市场免登接口客户购买商品后, 可通过免登接口登录到服务商系统云市场会根据新购商品接口中返回的 appinfo 中的 authurl, 结合下面参数组织一个用于免登的 url 地址,ISV 接到此 url 的请求后, 验证 token 是否合法, 确认 timestamp 是否符合 ISV 约束的时间, 来进行 ISV 管理后的自动登录 10

12 注 : 如要实现客户免登, 则要求服务商在发布商品时, 需要勾选需要客户授权中的手机或者邮箱选项请求参数 action true String verify instanceid true String 实例 ID timestamp true String 当前时间 (yyyy-mm-dd HH:mm:ss) token true String 安全校验令牌调用示例 action= verify&instanceid=1&timestamp= :01: 接口调试描述为了保证使用 SaaS 接入方式的正确性, 为服务商在服务商管理平台搭建了应用接入调试界面服务商可以在此页面调试以上六个接口的正确性 11

13 1.4.8 实际案例展示安恒玄武盾 ( 前台页面规格信息展示 ( 多账户 ) 服务商管理平台规格信息展示 ( 多账户 ) 客户购买商品后, 管理控制台页面示例 12

14 13

Microsoft Word - 阿里云市场ISV接入文档 2副本.docx

Microsoft Word - 阿里云市场ISV接入文档 2副本.docx 1.3 目录 1.1 简介... 3 1.2 适用对象... 3 1.3 安全 &Key... 3 1.3.1 创建实例... 3 1.3.2 续费实例... 6 1.3.3 过期实例... 7 1.3.4 释放实例... 8 1.3.5 绑定域名... 8 1.3.6 验证接口... 9 1 文档版本纪录 : 版本号修改时间修改内容责任人 1.3 2015 年 1 月 13 日增加安全 &key