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

Size: px

Start display at page:

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

不司僪
5 years ago
Views:

1 1.3

2 目录 1.1 简介适用对象安全 &Key 创建实例续费实例过期实例释放实例绑定域名验证接口

3 文档版本纪录 : 版本号修改时间修改内容责任人年 1 月 13 日增加安全 &key 中调用接口的编码逻辑, 增加参数 skuid 的描述南乡 2

4 1.1 简介本文档描述了第三方应用接入到阿里云市场所须实现的接口定义, 服务商通过提供以下接口, 即可获得应用订购成功的信息, 从而为购买者开通应用文档中涉及到的所有接口都以 HTTP GET 方式调用, 消息传输以 JSON 格式 1.2 适用对象 SaaS 类应用, 纯脚本部署的应用, 镜像方式部署的应用 1.3 安全 &Key 每次接口调用都必须做安全校验, 每次调用接口时候都会附加一个 token, 服务商拿到 token 以后应该对 token 进行校验 Token 的生成方式是 : 取所有的 http get 请求参数 ( 排除 token), 对参数名进行字典排序, 在字符串的最后加上你的 key, 然后对整个字符串进行 md5 加密上述安全 Key 在服务商入驻云市场成功后, 在管理后台 (msp.aiyun.com) 中可以查看到示例 : 那么 token 的生成规则 token= p1=1&p2=2&p3=3&key=isvkey.tomd5() 云市场发送的请求是对 ur 进行了 UTF-8 编码操作的, 所以服务商的生产接口在接收请求后是需要解码的以下是云市场调用接口的编码逻辑示例 : 编码后示例 : encode(p1) + = encode(1) + & + enode(p2) + = + encoede(2) + & + encode(p3) + = + & + token=xxxx 创建实例描述用户购买商品并付款成功, 云市场将调用本接口, 通知服务商开始创建应用实例, 每次创建的应用实例需要返回一个唯一的标识 (instanceid), 后续续费过期等 3

5 操作云市场会使用此标识 instanceid 的值建议直接使用云市场传入的 orderbizid 请不要阻塞此接口, 若耗时较长, 可使用队列做缓冲, 设置 instanceid=0, 然后立即返回若操作失败也请设置 instanceid=0, 云市场都会再次调用, 直到获取到 instanceid 该接口可能会被多次调用, 如果被重复调用, 请保证接口的幂等性参数 action true String createinstance aiuid true String 用户唯一标识 orderbizid true String 云市场业务 ID orderid true String 云市场订单 ID skuid true String 商品规格标识, 与商品唯一对应, 可在商品管理的销售信息中查看 accountquantity fase Int 帐号数量, 适用于以帐号数量形式售卖的商品 expiredon fase DateTime 过期时间 (yyyy-mm-dd HH:mm:ss) tempate fase String 模板 ID, 适用于模板类建站商品 corpid fase String 钉钉企业 ID, 适用于钉钉类商品 emai fase String 用户邮箱 mobie fase String 用户手机返回 instanceid true String 实例 ID, 服务商提供的唯一标识 hostinfo fase 固定 JSON Key 名称说明 name 主机名 4

6 ip 服务器 ip innerip 服务器内网 ip username 服务器帐号 password 服务器密码 cname 服务器 CNAME tempdomain 临时域名 ftpusername ftp 用户名 ftppassword ftp 密码 region 机房信息 beianinfo 备案地址 databaseinfo 数据库信息 appinfo fase 固定 JSON Key 名称说明 frontendur 前台地址 adminur 管理地址 username 管理员帐号 password 管理员密码 authur 免登地址 info fase JSON 自定义 Key-Vaue 数据调用示例 token=097a56e26a93c874140bbcdf403f3f60&action=createinstance&aiui d= &orderid=100001&orderbizid=1&skuid=sku 返回示例 { "instanceid": "1", "hostinfo": { "name": "inux server", "ip": " ", 5

7 "username": "root", "password": "root_password" }, "appinfo": { "frontendur": " "adminur": " "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) 返回 success true Booean 是否成功调用示例 6

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

9 1.3.4 释放实例描述云市场将在释放客户购买的产品时调用该接口, 服务商接收到该通知以后可以删除指定的实例参数 action true String reeaseinstance instanceid true String 实例 ID 返回 success true Booean 是否成功调用示例 action=reeaseinstance&instanceid= 返回示例 { success : true } 绑定域名描述云市场在用户绑定域名时调用该接口参数 8

10 action true String binddomain instanceid true String 实例 ID domains true String 以逗号隔开的域名字符串返回 success true Booean 是否成功调用示例 action=binddomain&instanceid=1&domains=yourdomain.com 返回 { success : true } 验证接口描述云市场验证接口可用于免登到 ISV 管理后台有些商品生产成功后, 有免登到 ISV 管理后台需求, 云市场会根据 createinstance 返回的 appinfo 中的 authur, 结合下面参数组织一个用于免登的 ur 地址,ISV 接到此 ur 的请求后, 验证 token 是否合法, 确认 timestamp 是否符合 ISV 约束的时间, 来进行 ISV 管理后的自动登录 9

11 参数 action true String verify instanceid true String 实例 ID timestamp true String 当前时间 (yyyy-mm-dd HH:mm:ss) 调用示例 action= verify&instanceid=1&timestamp= :01:01 10

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

Microsoft Word - 阿里云市场ISV接入文档 (修改版).docx 阿里云市场 ISV 接入文档 1.4 目录 1.1 简介... 3 1.2 适用对象... 3 1.3 前期准备... 3 1.4 接口描述... 4 1.4.1 新购商品... 4 1.4.2 商品续费... 7 1.4.3 商品过期... 8 1.4.4 释放商品资源... 9 1.4.5 绑定域名... 9 1.4.6 免登接口... 10 1.4.7 接口调试... 11 1.4.8 实际案例展示...