修订记录 : 版本号修订人修订日期修订描述 V 创建初稿修改渠道应用查询接口,xtype 支持多个, 增加搜索 keyword 参数渠道应用下载接口返回增加 :versioncode versionname

Size: px

Start display at page:

Download "修订记录 : 版本号修订人修订日期修订描述 V 创建初稿修改渠道应用查询接口,xtype 支持多个, 增加搜索 keyword 参数渠道应用下载接口返回增加 :versioncode versionname"

副习
5 years ago
Views:

2 修订记录 : 版本号修订人修订日期修订描述 V 创建初稿修改渠道应用查询接口,xtype 支持多个, 增加搜索 keyword 参数渠道应用下载接口返回增加 :versioncode versionname 应用查询接口增加仓库 ID 数据查询接口增加 billingtype 属性数据查询接口增加 packagename 属性增加 3.3 渠道应用榜单数据查询接口内部资料第 1 页注意保密

3 目录前言适用范围接口规范请求消息格式定义响应消息格式定义接口定义渠道应用获取下载接口渠道应用数据查询接口... 6 前言

4 1 适用范围本规范规定了第三方系统不卓望数码开放运营系统之间的接口内部资料第 1 页注意保密

5 2 接口规范 1. 所有请求采用 UTF-8 格式的 XML; 2. 消息采用 HTTP Post 短连接传递 ; 3. 返回数据根据具体的接口返回 UTF-8 格式的文本 ( 普通文本或者 XML 格式 ); 2.1 请求消息格式定义请求消息采用 UTF-8 格式的 XML 文本, 通过 HTTP POST 发送到 MM 端, 请求消息如下 : 序号父元素名称元素名称约束类型宽度描述取值说明 1 req 1 String 根节点 1.1 req 字段名称 + 类型字段节点丼例 : <req> <contentid>xxxx</contentid> </req> 约束说明 ( 下同 ): 1: 有且仅有一个 ; *: 有 0 到多个 ; +: 有 1 到多个 ; 数据类型说明 ( 下同 ) 日期类型 : 长日期格式 :yyyy/mm/dd HH:mm:ss, 短日期格式 :yyyy/mm/dd Int 型数据, 如果传入非 Int 型数据使用默认值取代, 详细参考各接口的说明 ; 内部资料第 2 页注意保密

6 2.2 响应消息格式定义序号父元素名称元素名称约束类型宽度描述取值说明 1 resp 1 String 根节点 1.1 resp code 1 String 返回码 0: 成功 400: 限制访问 403: 禁止访问 404: 服务找丌到 500: 内部错误 501 参数丌能为空 507 其他异常 1.2 resp msg 1 String 返回信息 1.4 resp count 1 Int 返回内容个数 1.3 resp body 1 String body xxx + String 响应消息体示例 : <resp> <code>0</code> <msg></msg> <count>4</count> <body> <content /> <content /> <content /> <content /> </body> </resp> 内部资料第 3 页注意保密

7 3 接口定义 3.1 渠道应用获取下载接口通过 HTTP GET 方式访问测试服务器地址 : [ 测试环境 ] xxxxxxxxxxxxxxxxxxx [ 现网环境 ] xxxxxxxxxxxxxxx 接口参数说明 : 字段说明长度必须 appid MM 应用 ID 12 位必须 channelid MM 开放运营渠道 ID 10 位必须 imsi 手机 IMSI 号 32 位必须序号返回内容格式 : 父元素名称元素名称约束类型描述取值说明 resp 有且只有一个 String 根节点内部资料第 4 页注意保密

8 序号父元素名称接口规格说明书 _M-Market_OOP 元素名称约束类型描述取值说明 resp code 有且只有一个 String 返回码 0: 成功 400: 限制访问 500 内部错误 501 参数丌能为空 502 应用丌存在 112 该应用目前是下载收费应用, 请到 MM 平台下载 101 应用在 MM 平台中丌存在 103 应用在 MM 平台中未开通 resp msg 有且只有一个 resp body 有且只有一个 body url 有且只有一个 String 返回信息 - 复合节点 String 复合节点生成 URL 地址 body versioncode String 版本代码 body versionname String 版本名称 <?xml version="1.0" encoding="utf-8"?> <resp> <code>0</code> <msg></msg> <body> <url> 内部资料第 5 页注意保密

9 <versioncode>1</versioncode> <versionname>1.1.1</versionname> </body> </resp> 3.2 渠道应用数据查询接口协议 :HTTP POST 短连接方向 :cms-> 卓望数码能力网关 URL: [ 测试环境 ] [ 现网环境 ] 描述 : 此接口用户查询货架商品信息, 接口需要指定查询的字段, 查询条件查询字段查询条件取值范围, 见接口下文描述请求内容格式 : 序号父元素名称元素名称约类型宽度描述取值说明束 req 1 String 根节点 req channelid 0 String 渠道号 channelid 不 parentid 必须 2 选 1, 并且 channelid 优先级高于 parentid 内部资料第 6 页注意保密

10 序号父元素名称元素名称约类型宽度描述取值说明束 req parentid 0 String 榜单类型 : : 收入排行榜 ( 周 ) : 最热下载榜 ( 周 ) : 最新榜 ( 月 ) channelid 不 parentid 必须 2 选 1, 并且 channelid 优先级高于 parentid req name 0 String 应用名称模糊匹配, 非必填参数 req xtype 0 String 一级分类非必填参数, 传输参数务必为以下数值 : game 表示游戏 software 表示软件 theme 表示主题传递非以上数值报错误异常允许传入多个以及分类, 多个 1 级分类间使用英文逗号分开 (,); req keyword 0 String 搜索关键字为空时丌做处理, 非空时, 使用模糊搜索应用名称应用标签和应用说明 req start 1 String 开始行默认 0, 必填 req pagesize 1 String 分页大小默认 50, 超过 50 返回错误异常返回内容格式 : 内部资料第 7 页注意保密

11 序号父元素名称元素名称约束类型宽度描述取值说明 resp 1 String 根节点默认按 sortid 降序排序 resp code 1 String 返回码状态码, 0 为成功,501 为参数错误, 502 为网络异常 resp msg 1 String 返回信息返回消息内容 resp count 1 Int 返回数据记录条数 resp body 1 - 复合节点 body content * - 复合节点 content [field-name] + String 字段名为调用者选择的字段名, 取值为该字段该行对应的字段值 ; 示例 : 请求 : <?xml version="1.0" encoding="utf-8"?> <req> </req> <channelid> </channelid> <xtype>software</xtype> <start>0</start> <pagesize>1</pagesize> 返回 : <?xml version="1.0" encoding="utf-8"?> <resp> <code>0</code> <msg></msg> <count>1</count> <body> <content> <appcatename> 棋牌 </appcatename> <appcateid>15</appcateid> <xtype> nt:gcontent:appgame</xtype> <contentid> </contentid> <name> 愤怒小鸟 </name> <lupddate> :38:48</lupddate> 内部资料第 8 页注意保密

12 <programsize> </programsize> <seriesname>1.0</seriesname> <introduction><![cdata[ 愤怒小鸟 ]]></introduction> <platform> {android} </platform> <logo1><![cdata[ ]]></logo1> <logo2><![cdata[ ]]></logo2> <logo3><![cdata[ ]]></logo3> <logo4><![cdata[ ]]></logo4> <clientpreviewpicture1><![cdata[ ]]></clientpreviewpicture1> <clientpreviewpicture2><![cdata[ ]]></clientpreviewpicture2> <sortid>sortid</sortid> <billingtype> 1</billingtype> <packagename> </packagename> </content> <content> <appcatename> 棋牌 </appcatename> <appcateid>15</appcateid> <xtype> nt:gcontent:appgame</xtype> <contentid> </contentid> <name> 愤怒小鸟 </name> <lupddate> :38:48</lupddate> <programsize> </programsize> <seriesname>1.0</seriesname> <introduction><![cdata[ 愤怒小鸟 ]]></introduction> <platform> {android} </platform> <logo1><![cdata[ ]]></logo1> <logo2><![cdata[ ]]></logo2> <logo3><![cdata[ ]]></logo3> <logo4><![cdata[ ]]></logo4> <clientpreviewpicture1><![cdata[ ]]></clientpreviewpicture1> <clientpreviewpicture2><![cdata[ ]]></clientpreviewpicture2> <billingtype> 1</billingtype> <packagename> </packagename> <sortid>sortid</sortid> </content> </body> </resp> 字段描述 : appcatename: 二级分类名称 appcateid: 二级分类 ID xtype: 一级分类 ID contententid: 应用 ID 内部资料第 9 页注意保密

13 name: 应用名称 lupddate: 更新时间 programsize: 应用大小 ( 字节 ) seriesname: 应用版本号 introduction: 应用描述 platform: 程序包的平台类型 : 取值包括 Kjava mobile symbian 等 logo1: 终端展示 LOGO1 地址, 图片规格 :30x30 logo2: 终端展示 LOGO2 地址, 图片规格 :34x34 logo3: 终端展示 LOGO3 地址, 图片规格 :50x50 logo4: 终端展示 LOGO4 地址, 图片规格 :50x50 clientpreviewpicture1: 详细大图, 软件使用截图 1 240*320 clientpreviewpicture2: 详细大图, 软件使用截图 2 240*320 sortid: 排序字段 billingtype: 计费类型 ; 1 tb 计费, 2 应用内付费, 3 下载计费,4 免费 packagename: 包名 3.3 渠道应用榜单数据查询接口协议 :HTTP GET 短连接方向 :cms-> 卓望数码能力网关 URL: [ 测试环境 ] =2 [ 现网环境 ] 描述 : 此接口用户查询固定货架下 APRU 商品信息, 接口需要指定查询的字段, 查询条件查询字段查询条件取值范围, 见接口下文描述请求参数 : 内部资料第 10 页注意保密

14 序号参数名称约类型宽度描述取值说明束 ranktype 0 String 榜单类型必填, 为空返回 501 错误取值范围 : 0: 应用最新榜 ( 月 ) 1: 应用最热下载榜 ( 周 ) 2: 应用收入排行榜 ( 周 ) start 1 String 开始行默认 0, 必填 pagesize 1 String 分页大小默认 50, 超过 50 返回错误异常返回内容格式 : 序号父元素名称元素名称约束类型宽度描述取值说明 resp 1 String 根节点默认按 sortid 降序排序 resp code 1 String 返回码状态码, 0 为成功,501 为参数错误, 502 为网络异常 resp msg 1 String 返回信息返回消息内容 resp count 1 Int 返回数据记录条数 resp body 1 - 复合节点 body content * - 复合节点 content [field-name] + String 字段名为调用者选择的字段名, 取值为该字段该行对应的字段值 ; 示例 : 请求 : 内部资料第 11 页注意保密

15 &ranktype=2 返回 : <?xml version='1.0' encoding='utf-8'?> <resp> <code>0</code> <msg></msg> <count>1</count> <body> <content> <appcatename> 植物 </appcatename> <appcateid>30</appcateid> <xtype>nt:gcontent:apptheme</xtype> <contentid> </contentid> <name> 主题开放运营 001</name> <lupddate> :56:49</lupddate> <programsize> </programsize> <seriesname>0</seriesname> <introduction><![cdata[ 主题开放运开放运营 001]]></introduction> <platform>{android}</platform> <logo1><![cdata[ 657/695/ /logo130x _src.jpg]]></logo1> <logo2><![cdata[ 658/695/ /logo134x _src.jpg]]></logo2> <logo3><![cdata[ 659/695/ /logo150x _src.jpg]]></logo3> <logo4><![cdata[ 660/695/ /logo165x _src.jpg]]></logo4> <clientpreviewpicture1><![cdata[ /21/2013/06/04/a663/695/ /picture1240x jpg]]></clien tpreviewpicture1> <clientpreviewpicture2><![cdata[ /21/2013/06/04/a667/695/ /picture1240x jpg]]></clien tpreviewpicture2> <billingtype>2</billingtype> <packagename><![cdata[com.qa.com]]></packagename> <rank>6.75</rank> <sortid>1000</sortid> </content> </body></resp> 字段描述 : appcatename: 二级分类名称内部资料第 12 页注意保密

16 appcateid: 二级分类 ID xtype: 一级分类 ID contententid: 应用 ID name: 应用名称 lupddate: 更新时间 programsize: 应用大小 ( 字节 ) seriesname: 应用版本号 introduction: 应用描述 platform: 程序包的平台类型 : 取值包括 Kjava mobile symbian 等 logo1: 终端展示 LOGO1 地址, 图片规格 :30x30 logo2: 终端展示 LOGO2 地址, 图片规格 :34x34 logo3: 终端展示 LOGO3 地址, 图片规格 :50x50 logo4: 终端展示 LOGO4 地址, 图片规格 :50x50 clientpreviewpicture1: 详细大图, 软件使用截图 1 240*320 clientpreviewpicture2: 详细大图, 软件使用截图 2 240*320 sortid: 排序字段 billingtype: 计费类型 ; 1 tb 计费, 2 应用内付费, 3 下载计费,4 免费 packagename: 包名 rank: 榜单数据内部资料第 13 页注意保密

接口规格说明书_M-Market_开放运营平台

接口规格说明书_M-Market_开放运营平台接口规格说明书 _M- M a r k e t _ 开放运营平台版本号 : 1. 0. 0. 0 卓望数码技术 ( 深圳 ) 有限公司版权所有修订记录 : 版本号修订人修订日期修订描述 V1.0 2012-08-07 创建初稿 1.1 2012-11-02 修改渠道应用查询接口,xtype 支持多个, 增加搜索 keyword 参数 1.2 2013-4-9 渠道应用下载接口返回增加 :versioncode

修订记录 : 版本号 修订人 修订日期 修订描述 V 创建初稿 修改渠道应用查询接口,xtype 支持多个, 增加搜索 keyword 参数 渠道应用下载接口返回增加 :versioncode versionname

修订记录 : 版本号修订人修订日期修订描述 V 创建初稿修改渠道应用查询接口,xtype 支持多个, 增加搜索 keyword 参数渠道应用下载接口返回增加 :versioncode versionname