搜漫网接口文档-V0.1.0

搜漫网数据接口V0.1.0中间层接口规范

文档修改说明版本作者版本变化内容描述完成日期审核人审核日期0.1.0涂凌翔创建文档2016-09-28

目录1.概述 51.1. 基本说明 51.2. 数据交互说明 51.3. 数据结构说明 51.3.1. 公用数据包装类 51.3.2. 一般数据结构 51.3.3. 结果数据结构 61.3.4. 分页数据结构 61.3.5. 列表数据结构 61.4. 服务端和客户端数据映射关系 71.4.1. 终端类型 71.4.2. 密码规则 72.接口说明 72.1. [模块1]首页 72.1.1. 获取艺术品分类列表 72.1.2. 获取艺术品列表 82.1.3. 关注艺术家 92.1.4. 点赞艺术品 92.1.5. 获取艺术品详情 102.1.6. 收藏艺术品 112.1.7. 获取用户收件地址列表 122.1.8. 添加/编辑用户收件地址 132.1.9. 删除用户收件地址 142.2. [模块2]名人堂 142.2.1. 获取艺术家列表 142.2.2. 获取艺术家详情 152.2.3. 获取店面下的艺术品列表 162.2.4. 获取艺术家评价列表 172.2.5. 添加/编辑艺术家风采/名作/荣誉 182.2.6. 删除艺术家风采/名作/荣誉 192.2.7. 获取艺术家风采/名作/荣誉列表 192.3. [模块3]作坊 202.3.1. 用户手机验证 202.3.2. 用户手机注册 202.3.3. 用户密码重置 212.3.4. 用户登录 212.3.5. 获取个人资料 222.3.6. 个人资料保存 242.3.7. 添加/编辑艺术品 252.3.8. 艺术品下架 262.4. [模块4]订单处理 272.4.1. 确认订单 272.4.2. 订单付款变动确认 282.4.3. 订单付款支付端确认 282.4.4. 获取快递公司列表 292.4.5. 获取订单列表【卖家】 302.4.6. 获取订单列表【买家】 312.4.7. 订单发货 332.4.8. 确认收货 332.4.9. 申请退款 342.4.10. 卖家同意退款 342.4.11. 卖家不同意退款 352.4.12. 删除订单 352.4.13. 订单评价/修改评价 352.4.14. 订单追加评价 362.4.15. 获取产品评价列表 372.5. [模块5]会员 382.5.1. 获取关注的艺术家列表 382.5.2. 取消关注艺术家 392.5.3. 获取用户收藏的艺术品列表 392.5.4. 取消收藏艺术品 40

1.概述基本说明参数都是小写的；参数以严格的小写字母或者下划线开头，不能以数字开头；接口名称采用驼峰法，第一个单词为小写单词，其他为首字大写的单词，如list,doAction；数据交互说明服务端和客户端之间的数据交互，统一采用json格式数据；客户端提交到服务端，使用get直接请求数据结构说明公用数据包装类字段名字段说明类型备注code请求的返回码int200成功；其他失败，参考消息msg描述信息，一般用来封装错误信息stringdata返回结果集object服务端返回给客户端的数据body一般数据结构{

"code":200

"msg":"success描述错误信息",

"data":{

"user_id":1717,

"user_name":"张劲松",

"create_time":"2012-08-0115:56:56"

}

}分页数据结构{"code":200"msg":"success","data":{"total":1717,//服务端数据库该数据的总条数"page":1,//当前页数"total_page":1,//总页数"content":[//分页对象 { "user_id":1717, "user_name":"张劲松", "create_time":"2014-09-1510:49:48" }, { "user_id":1718, "user_name":"张劲松2", "create_time":"2014-09-1510:49:48" }, { "user_id":1719, "user_name":"张劲松3", "create_time":"2014-09-1510:49:48" }]}}列表数据结构{"code":200"msg":"success","data":{"total":3,//数据的总条数"content":[//列表对象 { "user_id":1717, "user_name":"张劲松", "create_time":"2014-09-1510:49:48" }, { "user_id":1718, "user_name":"张劲松2", "create_time":"2014-09-1510:49:48" }, { "user_id":1719, "user_name":"张劲松3", "create_time":"2014-09-1510:49:48" }]}}2.接口说明接口访问地址为：http://www.soman.wang/api.php[模块1]漫画获取热门漫画列表需求：获取热门漫画列表，在首页展示接口http://www.soman.wang/api.php?op=listHost接口参数1.字段说明： 无2.示例： http://www.soman.wang/api.php?op=listHost返回数据类型：列表数据结构字段说明：字段名字段说明类型备注car_id漫画IDint唯一值car_name漫画名称stringcar_img封面图片string封面图片的URLlast_volume最后卷stringis_completed是否完结bool0未完结1已完结heat_count人气int示例：{"code":200,"msg":"success","data":{"total":10,"content":[{"car_id":"1","car_name":"新网球王子","car_img":"/xpic/xwqwz.jpg","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"2","car_name":"有你的小镇","car_img":"/xpic/yndxz.jpg","last_volume":"","is_completed":"1","heat_count":"0"},{"car_id":"3","car_name":"美食的俘虏","car_img":"/xpic/msdfl.jpg","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"4","car_name":"NANA","car_img":"/xpic/028.jpg","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"5","car_name":"天上天下高清版","car_img":"/xpic/021.jpg","last_volume":"","is_completed":"1","heat_count":"0"},{"car_id":"6","car_name":"猎人","car_img":"/xpic/HUNTER.jpg","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"7","car_name":"魔法先生","car_img":"/xpic/076.jpg","last_volume":"","is_completed":"1","heat_count":"0"},{"car_id":"8","car_name":"死神","car_img":"/xpic/ss40.jpg","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"9","car_name":"海贼王","car_img":"/xpic/haizw54.jpg","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"10","car_name":"伪恋","car_img":"/xpic/伪恋.jpg","last_volume":"","is_completed":"0","heat_count":"0"}]}}获取漫画分页列表 需求：漫画分页列表，在搜索后或者索引页显示接口http://www.soman.wang/api.php?op=listCartoon接口参数1.字段说明：字段名字段说明类型空值备注page页数int可空默认是1page_size每页数量int可空默认是10key查询关键字string可空该参数用在搜索功能index漫画索引string可空该参数用在索引页面2.示例： http://www.soman.wang/api.php?op=listCartoon&page=1&page_size=5&index=a返回数据类型：分页数据结构字段说明：字段名字段说明类型备注car_id漫画IDint唯一值car_name漫画名称stringcar_img封面图片string封面图片的URLlast_volume最后卷stringis_completed是否完结bool0未完结1已完结heat_count人气intindex_key索引string漫画名称的拼音首位,从A-Z示例:{"code":200,"msg":"success","data":{"total":31,"page":1,"total_page":7,"content":[{"car_id":"190","car_name":"so女郎","car_img":"/xpic/soso.jpg","index_key":"s","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"472","car_name":"三国游戏","car_img":"/xpic/三国游戏.jpg","index_key":"s","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"470","car_name":"三国贵公子","car_img":"/xpic/三国贵公子.jpg","index_key":"s","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"459","car_name":"书之恋","car_img":"/xpic/书之恋.jpg","index_key":"s","last_volume":"","is_completed":"0","heat_count":"0"},{"car_id":"22","car_name":"侍魂-魔界轮回记","car_img":"/xpic/侍魂-魔界轮回记.jpg","index_key":"s","last_volume":"","is_completed":"1","heat_count":"0"}]}}获取漫画详情 需求：在查看漫画详情的时候调用接口http://www.soman.wang/api.php?op=cartoon接口参数1.字段说明： 字段名字段说明类型空值备注id漫画IDInt不可2.示例： http://www.soman.wang/api.php?op=cartoon&id=474返回数据类型：一般数据结构字段说明：字段名字段说明类型备注car_id漫画IDint唯一值car_name漫画名称stringcar_img封面图片string封面图片的URLlast_volume最后卷stringis_completed是否完结bool0未完结1已完结heat_count人气intindex_key索引string漫画名称的拼音首位,从A-Zauthor作者stringregion地区stringlaunch_date发行时间stringprotagonist主角stringcomments描述stringflat_list平台列表内容结构拥有该漫画资源的平台列表，参考下表字段名字段说明类型备注flat_id平台IDintflat_name平台名称stringflat_url平台主页stringfcar_id平台中该漫画的IDintis_completed是否完结stringlast_volume最后卷stringurl平台中该漫画的Urlstring示例：{"code":200,"msg":"success","data":{"car_id":"474","car_name":"死亡深渊","car_img":"/xpic/死亡深渊.jpg","index_key":"s","author":"中村步","region":"","launch_date":"","protagonist":"","last_volume":"","comments":"死亡深渊,少女藏起来，少年去寻找，这个「约定」不久之后竟成了「诅咒」——。不能去看的世界，居然离我们如此之近……","is_completed":"0","heat_count":"0","flat_list":[{"flat_name":"KuKu","flat_url":"","fcar_id":"474","is_completed":"0","last_volume":"","flat_id":"2","url":"/comiclist/1782/index.htm"}]}}获取漫画画卷的列表 需求：在漫画详情的下方展示该漫画对应的画卷接口http://www.soman.wang/api.php?op=listVol接口参数1.字段说明：字段名字段说明类型空值备注fid平台中该漫画的IDint不可空flat_id平台IDint不可空2.示例：http://www.soman.wang/api.php?op=listVol&fid=474&flat_id=2返回数据类型：列表数据结构字段说明：字段名字段说明类型备注vol_id画卷IDintvol_name画卷名称stringvol_url画卷地址string示例：{"code":200,"msg":"success","data":{"total":11,"content":[{"vol_id":"8399","vol_name":"死亡深渊11话","vol_url":"/comiclist/1782/37635/1.htm"},{"vol_id":"8396","vol_name":"死亡深渊10话","vol_url":"/comiclist/1782/37284/1.htm"},{"vol_id":"8395","vol_name":"死亡深渊9话","vol_url":"/comiclist/1782/36806/1.htm"},{"vol_id":"8394","vol_name":"死亡深渊8话","vol_url":"/comiclist/1782/36204/1.htm"},{"vol_id":"8393","vol_name":"死亡深渊7话","vol_url":"/comiclist/1782/35719/1.htm"},{"vol_id":"8397","vol_name":"死亡深渊6话","vol_url":"/comiclist/1782/34882/1.htm"},{"vol_id":"8392","vol_name":"死亡深渊5话","vol_url":"/comiclist/1782/34198/1.htm"},{"vol_id":"8390","vol_name":"死亡深渊4话","vol_url":"/comiclist/1782/33703/1.htm"},{"vol_id":"8386","vol_name":"死亡深渊3话","vol_url":"/comiclist/1782/33608/1.htm"},{"vol_id":"8389","vol_name":"死亡深渊2话","vol_url":"/comiclist/1782/33607/1.htm"},{"vol_id":"8391","vol_name":"死亡深渊1话","vol_url":"/comiclist/1782/33606/1.htm"}]}}获取漫画画卷详情 需求：在浏览漫画的时候调用该接口接口http://www.soman.wang/api.php?op=vol接口参数1.字段说明：字段名字段说明类型空值备注id画卷IDint不可空对应vol_id参数flat_id平台IDint不可空2.示例：http://www.soman.wang/api.php?op=vol&id=8393&flat_id=2返回数据类型：一般数据结构字段说明：字段名字段说明类型备注vol_id画卷IDintvol_index画卷排序int越小越靠前page_count图片数量intvol_name画卷名称stringvol_url画卷string pic_info图片地址字符串列表示例：{"code":200,"msg":"success","data":{"vol_id":"8393","vol_index":"5","page_count":"41","vol_name":"死亡深渊7话","vol_url":"/comiclist/1782/35719/1.htm","pic_info":["/newkuku/2013/201308/20130829/[死亡深渊][第07话]/00103G.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0030B4.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0040EY.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0050IS.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0060MM.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0070QG.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0080UA.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0090Y4.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/01011Y.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/01115S.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/01219M.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0131DG.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0141HA.jpg","/newkuku/2013/201308/20130829/[死亡深渊][第07话]/0151L4.jpg","/newkuku/2013/201308/20130829/[死亡深渊]