APP应用组件接口使用文档
2019-08-23 17:11   |   1931人已读
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组件类型不能为空


开屏组件

APP-开屏组件

请求参数


名称

类型

必须

请求值

描述

comIdint1743

组件配置ID

typeint

8

底部开屏



响应参数

名称

类型

示例值

描述

dataTypeint
数据类型:1-商品列表 2-活动列表
mallUrlString
跳转地址 data_type=2时才有
frontImgString
图片地址 data_type=2时才有
showTypeint
展现形式
listlist
数据集 data_type=1时才有
list.dTitleString
数据集 短标题
list.goodsidString
数据集 商品id
list.isTmallint
数据集 是否天猫
list.urlString
数据集 跳转地址
list.picString
数据集 图片地址
list.priceBigDecimal
数据集 券后价
list.quanJineBigDecimal
数据集 券金额
list.tagString
数据集 好券标签/ 聚划算标签
list.tag1String
数据集 tag1
list.typeint
数据集 1:平台详情,2:外部链接


活动列表类型示例:

{

   "code": "1",

   "msg": "success",

   "data": {

       "front_img": "https://thumbnail.dataoke.com/img/dtk/article/201911/2019111117595593717002.png",

       "mall_url": "http://bxk.haojiequ.com/api/wap/component/click-static/v1?url=aHR0cDovL2J4ay5oYW9qaWVxdS5jb20vP3I9d2FwJmFwcGtleT00MmQ2MmNjOCZ0ZW1wa2V5PWZjOTk3YWU4Iy9ydXNoaW5nUmFua2luZw&comptType=12&comId=1744&comptId=247",

       "show_type": 0,

       "data_type": 2

   }

}


商品列表类型示例:

{

   "code": "1",

   "msg": "success",

   "data": {

       "list": [

           {

               "pic": "https://img.alicdn.com/imgextra/i1/2778263183/2778263183.png",

               "tag": "天猫",

               "tag1": "19.90元买5份",

               "quanJine": 10.00,

               "istmall": 1,

               "dtitle": "【拍5份】李佳琦推荐红谷林小石头饼",

               "jiage": 19.90,

               "url": "http://bxk.haojiequ.com/api/wap/component/click-static/v1?"

           }

       ],

       "show_type": 0,

       "data_type": 1

   }

}


信息流组件

信息流组件

请求参数

名称

类型

必须

请求值

描述

comIdint1741

组件配置ID

typeint8

信息流橱窗


响应参数

名称

类型

示例值

描述

mall_urlString
跳转地址
front_imgString
组件图片素材
show_typeInt

1.开屏组件 2.橱窗组件 3.搜索组件 4.插屏组件 5.浮窗组件 6.信息流

show_intervalInt
展示间隔
data_typeInt
1-商品列表 2-活动列表
countint
商品数量
datalist
商品数据列表
data.picString
商品图片地址
data.xiaoliangint
商品销量
data.quanJinedecimal
优惠券金额
data.dtitleString
商品短标题
data.jiagedecimal
商品券后价
data.yuanjiadecimal
商品原价
data.urlString
商品详情页地址
tagString
商品类型标签
tag1String
卖点标签


活动列表类型:

{

   "code": "1",

   "msg": "success",

   "data": {

       "front_img": "https://thumbnail.dataoke.com/img/dtk/article/201911/2019111117595593717002.png",

       "mall_url": "http://bxk.haojiequ.com/api/wap/component/click-static/v1?url=aHR0cDovL2J4ay5oYW9qaWVxdS5jb20vP3I9d2FwJmFwcGtleT00MmQ2MmNjOCZ0ZW1wa2V5PWZjOTk3YWU4Iy9ydXNoaW5nUmFua2luZw&comptType=12&comId=1741&comptId=238",

       "show_type": 0,

       "data_type": 2

   }

}


商品列表类型:

{

   "code": "1",

   "msg": "success",

   "data": {

       "list": [

           {

               "pic": "https://img.alicdn.com/imgextra/i3/2206509957889/O1CN0192G0Mc289DAdoo5Jl_!!2206509957889.jpg",

               "tag": "天猫",

               "tag1": "7.80元购6支",

               "quanJine": 1.00,

               "istmall": 1,

               "dtitle": "晨光彩色拔盖中性笔6支装",

               "jiage": 7.80,

               "url": "http://bxk.haojiequ.com/api/wap/component/click-static/v1?url=aHR0cHM6Ly91bGFuZC50YW9iYW8uY29tL2NvdXBvbi9lZGV0YWlsP2U9Y3ZBUE1Rd0JWbzBFJTJCZEFiMUpvT09vVGJIN3M2VE05TFBwU2c3b29KYm5xMVYlMkZkJTJCZXdNQXdoNTUzSWx3TW13cVRkUFJqZVpnTjNvSEVOTWJpbHZ0MUphJTJGUTdDS2RJTlJTRXl2QUwzdjlMTHZJOXdSdiUyQkRxRnJDU3lMRnc0cXN1SjQ3cll2SWphRTIwJTJCYzVHendpNmdXNXVzNklrTUhXVVNuNHFYJTJCcmRkeGc2SGdzZHlZcUszTmw0WDFWV2pLYWhPY0JEWiUyRklUa2VjQUNNa2dtOFMzdVElM0QlM0QmdHJhY2VJZD0wYjA4NDQxMjE1OTU1MDEwNDUwNzQ1ODExZSZ1bmlvbl9sZW5zPWxlbnNJZDpUQVBJQDE1OTU1MDEwNDVAMGIwYWYwYzNfMGRmM18xNzM3YjQ1ZTU2NV80ODdiQDAxJnhJZD01VVEzWXJUWnJoaWIyMnVGbTlwTGxVOW5CNjhGU1g3T1kzaTdtNm5saElTNkMydVkydDI1VENmeFlSNmVORUpGMUpucWNXZ2E1WDRBTTJsYnliZUFBUW1FWHgxMUtoY3lKSW5nNVJQTFliU1kmYWN0aXZpdHlJZD0wNTQxM2I4NjhmNDU0NWM5OTVmNjA1NDEyZTg4ODAxMw&comptType=12&comId=1741&comptId=238"

           }

       ],

       "show_type": 2,

       "data_type": 1

   }

}


弹窗组件

弹窗组件.png

请求参数

名称

类型

必须

请求值

描述

comIdint1739

组件配置ID

typeint8

智能组件


响应参数

名称

类型

示例值

描述

mall_urlString
跳转地址
front_imgString
组件图片素材
show_typeInt

1.开屏组件 2.橱窗组件 3.搜索组件 4.插屏组件 5.浮窗组件 6.信息流

show_intervalInt
展示间隔


返回示例:

{

   "code": "1",

   "msg": "success",

   "data": {

       "front_img": "https://thumbnail.dataoke.com/img/dtk/article/201911/2019111117595593717002.png",

       "mall_url": "http://bxk.haojiequ.com/api/wap/component/click-static/v1?url=aHR0cDovL2J4ay5oYW9qaWVxdS5jb20vP3I9d2FwJmFwcGtleT00MmQ2MmNjOCZ0ZW1wa2V5PWZjOTk3YWU4Iy9ydXNoaW5nUmFua2luZw&comptType=12&comId=1739&comptId=230",

       "show_type": 3,

       "data_type": 2

   }

}


搜索组件

搜索组件.png

请求参数


名称

类型

必须

请求值

描述

comIdint1742

组件配置ID

typeint4

搜索组件

keywordsString衣服

用户输入的搜索关键词



响应参数

名称

类型

示例值

描述

mall_urlString
跳转地址


返回示例:


{

   "code": "1",

   "msg": "success",

   "data": {

       "mall_url": "http://bxk.haojiequ.com/?r=wap&appkey=42d62cc8&tempkey=fc997ae8#/search?keyWords="

   }

}


小型浮标组件

小型浮标组件.png

请求参数

名称

类型

必须

请求值

描述

comIdint1740

组件配置ID

typeint8

智能组件


响应参数

名称

类型

示例值

描述

mall_urlString
跳转地址
front_imgString
组件图片素材
show_typeInt

1.开屏组件 2.橱窗组件 3.搜索组件 4.插屏组件 5.浮窗组件 6.信息流

show_intervalInt
展示间隔


返回结果示例:

{

   "code": "1",

   "msg": "success",

   "data": {

       "front_img": "https://thumbnail.dataoke.com/img/dtk/article/201912/2019121217311783039035.gif",

       "mall_url": "http://bxk.haojiequ.com/api/wap/component/click-static/v1?url=aHR0cDovL2J4ay5oYW9qaWVxdS5jb20vP3I9d2FwJmFwcGtleT00MmQ2MmNjOCZ0ZW1wa2V5PWZjOTk3YWU4Iy9ydXNoaW5nUmFua2luZw&comptType=12&comId=1740&comptId=231",

       "show_type": 4,

       "data_type": 2

   }

}


以上信息若未解决您的问题,请联系官网客服