API接口


基础公共信息

API接口简介
为了更好的接入网盟的整个流程,包括查询推广订单信息,查询活动推广商品详细信息,查询单个商品详细信息等,考拉自有网盟提供一系列的查询相关的API,以供第三方使用
使用方式
在使用API之前,需要拥有API使用过程中的既有唯一凭证的unionId和加密密钥appSecret。 只有拥有平台审核通过的用户,后续的所有API调用才会成功。
签名方式
1.签名参数
参数名称 参数类型 是否必须 说明
timestamp String Y 时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2013-05-06 13:52:03。考拉API服务端允许客户端请求时间误差为6分钟。
v String Y API协议版本,可选值:1.0。
sign String Y 对 API 调用参数(除sign外)进行 md5 加密获得。
signMethod String Y 参数的加密方法选择,可选值是:md5
2.签名获取
调用查询API 时需要对请求参数进行签名验证,考拉服务器也会对该请求参数进行验证是否合法的。
方法如下:
2.1 根据参数名称(除签名和图片)将所有请求参数按照字母先后顺序排序:key + value .... key + value 例如:将foo=1,bar=2,baz=3 排序为bar=2,baz=3,foo=1,参数名和参数值链接后,得到拼装字符串bar2baz3foo1
2.2 系统同时支持MD5加密方式: md5:将secretKey 拼接到参数字符串头、尾进行md5加密后,再转化成大写, 格式是:byte2hex(md5(secretKeykey1value1key2value2...secretKey))
3.签名api使用说明
考拉提供签名生成api的jar包,cps联盟拿到后调用即可。
调用APIUtil createSign(String secretKey, TreeMap parameterMap)即可生成签名
查询API常见问题集
1)关于效果跟踪码tracking_code参数的处理
用户在下订单时,考拉读取COOKIES中tracking_code参数值。写入到订单表,并推送给cps联盟。如果下单时cookies中tracking_code参数无值或失效。那订单信息中tracking_code参数为空。
2)关于uid参数的处理
用户在下订单时,考拉读取COOKIES中u_id参数值。写入到订单表和用户表,并推送给cps联盟。
3)关于佣金分类编号comm_type参数的说明
由考拉设定后把分类编号提供给cps联盟技术对接人,有多少种佣金类型,就设多少个佣金分类编号,参数值只能是数字组成。(如果考拉有不参与返利的商品或订单也设一个为0%的分类)
补充说明
➢ 订单查询接口返回在指定起止时间内新产生、以及状态发生变化的订单,如果指定了status,则返回指定状态的订单;
➢ 订单查询接口中指定了order_id、status,则查询符合条件的订单数据;
➢ 查询接口中的channel_id、code参数由商家自行决定是否需要,code计算规则可双方协商确定,暂不使用统一加密算法;
➢ 考拉的订单中,区分为大订单和小订单,大订单指用户一次下单生成的订单;小订单指的一个大订单中的商品,从不同仓库发货,同一个仓库发货的为一个小订单;对应订单字段中,包含GORDER为大订单,ORDER为小订单
➢ 分类佣金说明(佣金及分类参考实际合同)
类目名称 分类ID 佣金
美容彩妆 437 0.03
数码家电 440 0.04
服装鞋包 1025 0.02
海外直邮 1121 0.1
母婴 438 0.01
美食保健 439 0.05
家居个护 372 0.05

查询推广订单信息

API接口描述
通过时间、订单号、unionId查看相关订单的具体数据
应用场景
API授权类型
不需要
接口调用请求说明
http请求方式: GET
接口地址:http://cps.kaola.com/cps/api/queryorder?unionId=xxxxx&orderId=xxxxxxx&status=1
返回数据格式:XML
系统级别输入参数
参数名称 参数类型 是否必须 说明
unionId String Y 联盟站长唯一标识
timestamp String Y 时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2013-05-06 13:52:03。考拉API服务端允许客户端请求时间误差为6分钟。
v String Y API协议版本,可选值:1.0。
sign String Y 对 API 调用参数(除sign外)进行 md5 加密获得。
signMethod String Y 参数的加密方法选择,可选值是:md5
应用级别输入参数
参数名称 参数类型 是否必须 说明
startDate String N 订单时间范围,开始时间,格式:1970-01-01 00:00:00
endDate String N 订单时间范围,结束时间,格式:1970-01-01 00:00:00
orderId String N 单个订单ID
status String N 订单状态,0:下单成功,1:已支付,2:已发货,3:交易成功,4:交易失败,5:过期关单
参数说明:orderId与startDate,endDate参数互斥,orderId存在的话,优先查询单一订单,orderId不存在,查询startDate和endDate范围内的订单
返回结果
参数名称 参数类型 可选 说明
orders 订单循环 必填 包含多个order节点
order 订单节点 必填 1个订单信息节点
order_id string 必填 订单号
order_time datetime 必填 订单生成时间
order_status int 必填 订单状态,商家同时需提供int值对应的实际状态含义,如:
0:下单
1:支付成功
2:已发货
3:交易成功
4:交易失败
5:取消订单
order_amount string 必填 订单金额
pay_amount string 必填 实际支付金额
actual_pay_amount string 必填 去除税费、优惠券等实际支付金额
commission_amount string 必填 佣金金额
commission_rate string 必填 佣金比率
app_type int 必填 app类型,0-web 1-wap
tracking_code String 必填 个人网站主标识信息
uid String 必填 个人网站主ID
order_items 商品节点 必填 多个商品循环
goods_id string 必填 商品ID
goods_name string 可选 商品名称
buy_count int 必填 购买商品数量
unit_price string 可选 商品单价
url string 必填 商品url
category_id String 必填 商品分类ID
category_name decimal 必填 商品类目名称
goods_pay_amount decimal 必填 商品实际支付金额
goods_commission_amount decimal 必填 商品佣金金额
goods_commission_rate decimal 必填 商品佣金比率
返回示例
http://cps.kaola.com/cps/api/queryorder?unionId=unionId&startDate=2015-07-20 15:59:03&endDate=2015-07-20 15:59:03&signMethod=md5& timestamp=2015-07-29 16:33:03&v=1.0&sign=A6D4EBC777BAAD56324E4EA7A8AE531B
注:返回指定时间段内新产生、以及状态发生变化(或指定status状态)的订单。
订单查询及推送采用一致的订单数据格式,示例如下:
<?xml version="1.0" encoding="UTF-8"?>;
<orders>
<order>
<order_id>2015100915331011021065765</order_id>
<order_amount>210.00</order_amount>
<pay_amount>210.00</pay_amount>
<actual_pay_amount>210.00</actual_pay_amount>
<order_status>0</order_status>
<commission_amount>18.90</commission_amount>
<commission_rate>9.00%</commission_rate>
<app_type>0</app_type>
<order_time>2015-10-09 15:33:41</order_time>
<order_items>
<order_item>
<goods_id>4575</goods_id>
<goods_name>12</goods_name>
<buy_count>1</buy_count>
<unit_price>210.00</unit_price>
<url><![CDATA[http://www.kaola.com/product/4575.html]]></url>
<category_id>311</category_id>
<category_name>奶粉</category_name>
<goods_pay_amount>18.90</goods_pay_amount>
<goods_commission_amount>18.90</goods_commission_amount>
<goods_commission_rate>9.00%</goods_commission_rate>
</order_item>
</order_items>
</order>
</orders>

查询活动推广商品详细信息

API接口描述
查看单个活动下活动明细及活动下的各个商品明细
应用场景
API授权类型
不需要
接口调用请求说明
http请求方式: GET
接口地址:http://cps.kaola.com/cps/api/queryActivityDetail?unionId=xxxxx&activityUrl=活动推广url
返回数据格式:XML
系统级别输入参数
参数名称 参数类型 是否必须 说明
unionId String Y 联盟站长唯一标识
timestamp String Y 时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2013-05-06 13:52:03。考拉API服务端允许客户端请求时间误差为6分钟。
v String Y API协议版本,可选值:1.0。
sign String Y 对 API 调用参数(除sign外)进行 md5 加密获得。
signMethod String Y 参数的加密方法选择,可选值是:md5
应用级别输入参数
参数名称 参数类型 是否必须 说明
activityUrl String Y 活动推广url
返回结果
参数名称 参数类型 可选 说明
activityShows 活动循环 必填 包含多个活动
activity 活动节点 必填 1个活动节点信息
activity_title String 必填 活动名称
activity_desc String 可选 活动说明
activity_start_date datetime 必填 活动开始时间
activity_end_date datetime 必填 活动结束时间
product_count int 必填 商品数量
commission_rate String 必填 佣金范围
products 商品循环 必填 包含多个商品
produt 商品节点 必填 包含一个商品节点信息
product_title String 必填 商品名称
product_price decimal 必填 商品价格
product_url String 必填 商品url
product_category String 必填 商品类目
返回示例
http://cps.kaola.com/cps/api/queryActivityDetail?unionId=unionId&activityUrl=activityUrl&signMethod=md5& timestamp=2015-07-29 16:33:03&version=1.0&sign=A6D4EBC777BAAD56324E4EA7A8AE531B
注:这个活动所有商品信息。
活动推广详情数据格式,示例如下:
<?xml version="1.0" encoding="UTF-8"?>;
<activityShows>
<activity>
<activity_title>9.29test3</activity_title>
<activity_desc/>
<activity_start_date>2015-09-29 15:07:09</activity_start_date>
<activity_end_date>2015-10-22 15:12:14</activity_end_date>
<product_count>5</activity_count>
<commission_rate>0.00%~0.00%</activity_rate>
<products>
<product>
<product_title><![CDATA[手机端库存测试]]></product_title>
<product_price><![CDATA[150]]></product_price>
<product_url><![CDATA[http://www.kaola.com/product/5048.html]]></product_url>
<product_category/>
</product>
<product>
<product_title><![CDATA[新年2015直邮@!@!@#&……————+]]></product_title>
<product_price><![CDATA[40.5]]></product_price>
<product_url><![CDATA[http://www.kaola.com/product/4911.html]]></product_url>
<product_category/>
</product>
</products>
</activity>
</activityShows>

查询单个商品详细信息

API接口描述
查询单个商品的详细情况
应用场景
API授权类型
不需要
接口调用请求说明
http请求方式: GET
接口地址:http://cps.kaola.com/cps/api/queryGoodsDetail?unionId=xxxxx&goodsIds=xxxxxxx&urls=xxxx&type=1
返回数据格式:XML
系统级别输入参数
参数名称 参数类型 是否必须 说明
unionId String Y 联盟站长唯一标识
timestamp String Y 时间戳,格式为yyyy-mm-dd HH:mm:ss,例如:2013-05-06 13:52:03。考拉API服务端允许客户端请求时间误差为6分钟。
v String Y API协议版本,可选值:1.0。
sign String Y 对 API 调用参数(除sign外)进行 md5 加密获得。
sign_method String Y 参数的加密方法选择,可选值是:md5
应用级别输入参数
参数名称 参数类型 是否必须 说明
goodIds String N 商品id(goods),多个用逗号分隔
urls String N 商品url,多个用逗号分隔
type String Y 商品id(goods)0:传的是urls,1:传的goodsIds
返回结果
参数名称 参数类型 可选 说明
goodsList 商品循环 必填 包含多个商品
goods 商品节点 必填 1个商品节点信息
product_id String 必填 商品ID
product_name String 必填 名称
product_price String 必填 价格
product_commision String 必填 佣金
product_image String 必填 图片
product_url String 必填 商品url
product_app_url String 必填 wap商品url
category_id String 必填 分类ID
product_category String 必填 分类名称
product_brand_zh String 必填 中文品牌
product_brand_en String 必填 英文品牌
product_brand_url String 必填 品牌url
product_country_zh String 必填 中文国家
product_country_en String 必填 英文国家
product_newname String 必填 产品名称
product_middlename String 必填 产品名称
product_third_category String 必填 三级类目
返回示例
http://cps.kaola.com/cps/api/queryGoodsDetail?unionId=unionId&goodsIds=goodsIds&type=type&signMethod=md5& timestamp=2015-07-29 16:33:03&version=1.0&sign=A6D4EBC777BAAD56324E4EA7A8AE531B
注:商品详细信息。
商品详情数据格式,示例如下:
<?xml version="1.0" encoding="UTF-8"?>;
<goodsList>
<goods>
<product_id>5048</product_id>
<product_name><![CDATA[手机端库存测试]]></product_name>
<product_price>10</product_price>
<product_commision>0</product_commision>
<product_image><![CDATA[http://haitao.nos.netease.com/testiblmf6l610001.jpg]]></product_image>
<product_url><![CDATA[http://www.kaola.com/product/5048.html]]></product_url>
<product_app_url><![CDATA[http://m.kaola.com/product/5344.html]]></product_app_url>
<category_id>372</category_id>
<product_category><![CDATA[买买买]]></product_category>
<product_brand_zh><![CDATA[kaola]]></product_brand_zh>
<product_brand_en/>
<product_brand_url><![CDATA[http://m.kaola.com/brand/962.html]]></product_brand_url>
<product_country_zh><![CDATA[巴林]]></product_country_zh>
<product_country_en>BL</product_country_en>
<product_newname><![CDATA[3件组合装 | Aptamil 德国爱他美 婴儿奶粉 Pre段 800克/罐]]></product_newname>
<product_middlename><![CDATA[巴林 kaola ]]></product_middlename>
<product_third_category><![CDATA[奶制品]]></product_third_category>
</goods>
</goodsList>

商务合作:hzzhuhao@corp.netease.com | 联系地址:浙江省杭州市滨江区网商路599号网易大厦| 邮编:310052| 联系电话:0571-89853186 朱先生
站长联系QQ群:229138781| 站长服务邮箱:cpskaola@service.netease.com

About NetEase 公司简介 联系方法 友情链接 招聘信息 客户服务 隐私政策 网络营销 网易考拉海购
增值电信业务经营许可证:浙B2-20090185-3 网易公司版权所有©1997-2017