APP应用组件接口使用文档
2019-08-23 17:11   |   1188人已读
APP应用通过接口使用组件。在使用接口时需要提供应用密钥以验证身份。本接口文档会随着组件更新而持续更新。


概述

APP应用通过接口使用组件。在使用接口时需要提供应用密钥以验证身份。本接口文档会随着组件更新而持续更新。


请求地址

环境HTTP地址HTTPS地址
正式环境http://bxapi.dataoke.com/api/wap/component/poolhttps://bxapi.dataoke.com/api/wap/component/pool
沙箱环境


签名算法

为了防止API调用过程中被恶意篡改,调用任何一个wap组件的API都需要携带签名,服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。目前支持的签名规则为md5,签名大体过程如下:

1. 对所有API请求参数(包括公共参数和业务参数,但除去sign参数,参数值为空的参数不需要加入签名),根据参数名称的ASCII码表的顺序排序。如:

foo=1, bar=2, foo_bar=3, foobar=4排序后的顺序是bar=2, foo=1, foo_bar=3, foobar=4

2. 将排序好的参数名和参数值拼装在一起,参数之间用&符号进行连接,参数值需要使用utf-8编码,根据上面的示例得到的结果为:

bar=2&foo=1&foo_bar=3&foobar=4

3. 把拼装好的字符串的尾部再拼接appSecret,根据上例为:

bar=2&foo=1&foo_bar=3&foobar=4&key=[应用中的secretKey],然后md5加密md5(bar=2&foo=1&foo_bar=3&foobar=4&key=[应用中的secretKey])


公共请求参数

参数名称参数类型是否必须示例参数描述
appKeyStringaa567eb2创建应用的时候生产的appkey
clientStringapp客户端类型,统一传:app
signStringd7ae1358d6071b21f075f838df103142签名规则


公共响应参数

参数名称参数类型是否必须参数描述
codeint1:表示成功,非1表示异常;具体异常code请见附录
msgString错误信息
dataObject返回指定组件数据


错误代码

code参数
88004001请带上认证信息
88004002appkey不能为空
88004003客户端信息不能为空
88004004appkey信息错误
88004005sign不能为空
88004006签名错误
88004007认证失败
88004008组件类型不能为空


右下领券浮窗组件

右下领券浮窗组件.png

请求参数

参数名称参数类型是否必须示例参数描述
typeint1右下领券浮窗组件
comIdint954组件配置ID

响应参数

参数名称参数类型是否必须参数描述
mall_urlString跳转地址
front_imgString组件图片素材


横幅图片组件

横幅图片组件.png

请求参数

参数名称参数类型是否必须示例参数描述
typeint2横幅图片组件
comIdint956组件配置ID

响应参数

参数名称参数类型是否必须参数描述
mall_urlString跳转地址
front_imgString组件图片素材


商品橱窗组件

商品橱窗组件.png

请求参数

参数名称参数类型是否必须示例参数描述
typeint3商品橱窗组件
comIdint957组件配置ID

响应参数

参数名称参数类型是否必须参数描述
countint商品数量
datalist数据列表
data.picString商品图片地址
data.xiaoliangint商品销量
data.quanJinedecimal优惠券金额
data.dtitleString商品短标题
data.jiagedecimal商品券后价
data.yuanjiadecimal商品原价
data.urlString商品详情页地址


搜索组件

搜索组件.png

请求参数

参数名称参数类型是否必须示例参数描述
typeint4商品橱窗组件
comIdint958组件配置ID
keywordsString衣服搜索关键词

响应参数

参数名称参数类型是否必须参数描述
mall_urlString跳转地址


以上信息若未解决您的问题,请联系QQ:3001154752点击这里给我发消息