ELLESHOP移动端API接口文档_的v1.0_20160701.docx

ElleShop接口设计一、 文档说明 描述文件状态：[√] 草 稿[ ] 正式发布[ ] 正在修改当前版本：1.0作 者：Leo_Ding文件密级：[ ]普通 [ ]秘密 [√]绝密文档版本版本/状态作者参与者日期说明1.0Leo_Ding2016-05-09初稿加密方式参数含义api_key分配给网站的客户端idnonce随机数timestampunix时间戳（从UTC时间1970年1月1日00:00:00到当前时刻的秒数）。version版本号，请固定使用1.0sign_method签名方法,默认为MD5，如无其他特殊加密方式的情况下，可以忽略辞职，可选参数sign签名值，用来提高传输过程参数的防篡改性。（参考签名生成规则）签名规则：固定参数（api_key, nonce, timestamp, version, sign_method）+具体业务接口参数+私钥私钥说明：私钥为客户端固有私钥，客户端与服务端双方共同持有，但在接口调用时不进行传递，在客户端生成sign参数时，放在所有参数的最后一位。同时，如无其他特殊加密方式sign_method参数默认为md5方式加密，在调用接口时，可以忽略这个参数，不用传输。加密参数顺序及格式：调用接口时，使用sing_method参数进行加密方式的说明时，格式如下：sign = MD5(api_key + nonce+ timestamp+ version+ sign_method + private_key)调用接口时，没有使用sing_method参数进行加密方式的说明时，格式如下：sign = MD5(api_key + nonce+ timestamp+ version+ private_key)请求步骤：(以用户登录为例)第1步：将除“sign”外的所有参数按key进行字典升序排列，并把private_key放到最后进行MD5加密得到sign值。如下顺序：：api_key,nonce,timestamp,version,sign_method,password, username, private_key100001,随机数,130000001, 1.0 , md5 , 123456 , root , 1000000001 第2步：提交请求之前设置http请求头accept参数，制定返回格式如要求返回json格式数据则accept= application/json，如要求返回xml格式数据则accept= application/xml注意:如果使用jquery的ajax函数提交数据,需要注意以下三个参数的设置：contentType: application/json,//application/xmlprocessData: true,//contentType为application/xml时，些值为falsedataType: json,//json--返回json数据类型；xml--返回xml第3步:使用get/post提交请求，如果是异步提交，建议用GET方式提交，提交时参数不用顾忌参数顺序问题，参数顺序由接口调整完成注意：接口参数有必填和选填两种，MD5码生成时，只使用必须参数进行MD5码生成。二、接口详情API—系统相关首页瀑布流1.1描述首页瀑布流。1.2.URL/index.php?route=mapi/home_waterfall1.3请求方式GET1.4请求参数说明参数字段必选类型长度限制说明page_idTrueint商品IDcategory_idTrueint导航分类ID 女1 男2 生活3 示例：/index.php?route=mapi/home_waterfallcategory_id=1page_id=11.5返回参数说明JSON示例{code:0,msg:success,data:[{object_id:63,object_title:衬衫女2016春装新款女装OL职业装,object_image:catalog\/product\/clothing\/women-clothing\/fision11-300x300.jpg,object_link:null,object_type:1}]}返字段说明参数字段类型说明codeInt如果成功为0，失败则返回错误编码msgString状态说明DataArray具体状态object_idint商品id product_nameString商品名称object_imageString商品图片object_idINT 五种 商品详情页1 品牌2 杂志3 活动4 视频5商品详情此图对应三个字段 manufacturer 名称