电商平台对接
本文档共分为商户对接及访客端对接两部分。目录如下:
1.商户对接
1.1对接步骤
操作步骤:管理员坐席登陆云客服,点击商户管理
商户管理 —> 一键开户
在开户页面配置商户的一些基本信息
在商户接入设置 —> 查看 获取商户的接入号ID
卡片接口对接
设置地址:系统设置 —> 对接设置 —> 商品信息填写已运行的url地址
示例:
http://140.143.60.140:8223/
接口鉴权:鉴权信息所使用的token和nonce,请在电商版平台端-系统设置-对接设置中获取。
鉴权处理流程:
1)获取请求参数token、timestamp
2)根据token查询nonce值
3)按照token、timestamp、nonce的顺序拼接成字符串,使用sha1算法计算signature值
4)和上送的signature值进行匹配,一致则鉴权成功
5)返回商品信息
请求参数:
字段名 | 备注 |
token | 系统获取的token |
timestamp | 时间戳(毫秒) |
nonce | 系统获取的nonce |
commodityId | 访客端传的商品id |
示例:
http://140.143.60.140:8223/?token=ezYuHCVU6f1KnqWjpN1TGYDztzBXwzNqiXagyvQtszI×tamp=1586331608718&signature=0a0f24c590e83b330ba6a9b0830baa6f1f6dfb3c&commodityId=12345
请求头:无
请求体:无
接口返回示例:
{
"data":{
"price":"¥79.00",
"imageUrl":"https://img10.360buyimg.com/n6/jfs/t1/88425/40/12091/294889/5e414e07Ecbd6b1b0/712bf44595d18f01.jpg",
"name":"一次性手套橡胶手套女塑胶男家用纹绣pvc手套透明检查胶皮薄款乳胶胶皮手套丁晴手套 PVC盒装【100只】 均码",
"desc":""
}
}
2. 访客端对接
访客端对接需要用户这边自定义一个按钮调用点击方法打开访客端咨询页面
2.1 PC接入
2.1.1 对接点击方法:
注:如果登录平台域名是ecom.7moor.com,则需要把下面的跳转域名改成echat.7moor.com
function accessDemoFun (data) {
let popup = window.open('https://yechat.7moor.com/index/' + data.accessId)
let timer=setTimeout(function () {
try {
popup.parent.postMessage({qmInitData: encodeURIComponent(JSON.stringify(data))}, '*')
clearTimeout(timer);
} catch(e){
console.log(e)
}
}, 600);
}
2.1.2 接入参数说明:
data: {
accessId: '', // 接入号ID (参数类型:字符串,必传)
userId: '', // 访客id 自定义用户的唯一id,不能传空字符串、null、中文,id由字母大小写、数字及'-'和 '_'组成(必传)
sidHeadImg: '', // 访客头像(参数类型:字符串,图片地址)
nickName: '', // 访客名称(参数类型:字符串)
venderId: '', // 商铺id (参数类型:字符串,用于展示右侧商铺信息)
venderName: '', // 商铺名称(参数类型:字符串,用于展示右侧商铺信息)
venderHeadImg: '', // 商铺头像 (参数类型:字符串,图片地址,用于展示右侧商铺信息)
commodityId: '', // 正在咨询的商品(参数类型:字符串)
}
2.1.3 接入示例:
自定义咨询点击按钮,点击执行定义好的accessDemoFun方法
<button onclick="accessDemoFun(data)"></button>
2.2 H5接入
2.2.1 对接点击方法:
function wapAccessDemoFun (data){
let hrefAddress = 'wap?accessId=' + data.accessId + '&userId=' + data.userId + '&commodityId=' + data.commodityId + '&sidHeadImg=' + data.sidHeadImg + '&nickName=' + data.nickName
window.open('https://yechat.7moor.com/' + hrefAddress)
}
2.2.2 接入参数说明:
data:{
accessId: '', // 接入号ID (参数类型:字符串,必传)
userId: '', // 访客id 自定义用户的唯一id,不能传空字符串、null、中文,id由字母大小写、数字及'-'和 '_'组成(必传)
sidHeadImg: '', // 访客头像(参数类型:字符串,图片地址)
nickName: '', // 访客名称(参数类型:字符串)
commodityId: '', // 正在咨询的商品(参数类型:字符串)
}
2.2.3 接入示例:
自定义咨询点击按钮,点击执行定义好的wapAccessDemoFun方法
<button onclick="wapAccessDemoFun(data)"></button>
3. 电商接口
3.1查询商品接口
3.1.1 接口鉴权
注:鉴权信息所使用的token和nonce,请在电商版平台端-系统设置-对接设置中获取。
3.1.2 请求头
无
3.1.3 请求参数
例如:
http://140.143.60.140:8223/?token=ezYuHCVU6f1KnqWjpN1TGYDztzBXwzNqiXagyvQtszI×tamp=1586331608718&signature=0a0f24c590e83b330ba6a9b0830baa6f1f6dfb3c&commodityId=12345
字段名 | 备注 |
---|---|
token | token |
timestamp | 时间戳 |
nonce | nonce |
commodityId | 商品id |
3.1.4 请求体
无
3.1.5 返回体
{
"data":{
"price":"¥79.00", //商品价格
"imageUrl":"https://img10.360buyimg.com/n6/jfs/ t1/88425/40/12091/294889/5e414e07Ecbd6b1b0/712bf44595d18f01.jpg", //商品图片地址
"name":"一次性手套橡胶手套女塑胶男家用纹绣pvc手套透明检查胶皮薄款乳胶胶皮手套丁晴手套 PVC盒装【100只】 均码", //商品名称
"desc":"" //商品描述
}
}
3.1.6 鉴权处理流程
1)获取请求参数token、timestamp 2)根据token查询nonce值 3)按照token、timestamp、nonce的顺序拼接成字符串,使用sha1算法计算signature值 4)和上送的signature值进行匹配,一致则鉴权成功 5)返回商品信息
3.1.7 对接设置
电商版平台端-系统设置-对接设置中填写已运行的url地址即可。 例如:
http://140.143.60.140:8223/
3.2 订单信息
3.2.1 接口鉴权
注:鉴权信息所使用的token和nonce,请在电商版平台端-系统设置-对接设置中获取。
3.2.2 请求头
无
3.2.3 请求参数
例如:
http://140.143.60.140:8223/?token=ezYuHCVU6f1KnqWjpN1TGYDztzBXwzNqiXagyvQtszI×tamp=1586331608718&signature=0a0f24c590e83b330ba6a9b0830baa6f1f6dfb3c&orderId=12345
字段名 | 备注 |
---|---|
token | token |
timestamp | 时间戳 |
nonce | nonce |
orderId | 订单id |
3.2.4 请求体
无
3.2.5 返回体
{
"data":[
{
"orderNum":"107576153756", //订单编号
"price":"¥17,999", //价格
"status":"已发货", //订单状态
"date":"19-12-12 11:52:36", //订单时间
"list":[
{
"price":"¥8,999", // 商品价格
"imageUrl":"https://img10.360buyimg.com/n6/jfs/t1/88425/40/12091/294889/5e414e07Ecbd6b1b0/712bf44595d18f01.jpg", //商品图片地址
"name":"海信(Hisense)HZ55E5D 55英寸 AI声控 MEMC防抖 超薄全面屏 4K超高清 人工智能A...", //商品名称
"desc":"海信(Hisense)HZ55E5D 55英寸 AI声控 MEMC防抖 超薄全面屏 4K超高清 人工智能A..." //商品描述
},
{
"price":"¥8,999", // 商品价格
"imageUrl":"https://img10.360buyimg.com/n6/jfs/t1/88425/40/12091/294889/5e414e07Ecbd6b1b0/712bf44595d18f01.jpg", //商品图片地址
"name":"海信(Hisense)HZ55E5D 55英寸 AI声控 MEMC防抖 超薄全面屏 4K超高清 人工智能A...", //商品名称
"desc":"海信(Hisense)HZ55E5D 55英寸 AI声控 MEMC防抖 超薄全面屏 4K超高清 人工智能A..." //商品描述
}
]
}
]
}
3.2.6 鉴权处理流程
1)获取请求参数token、timestamp 2)根据token查询nonce值 3)按照token、timestamp、nonce的顺序拼接成字符串,使用sha1算法计算signature值 4)和上送的signature值进行匹配,一致则鉴权成功 5)返回商品信息
3.2.7 对接设置
电商版平台端-系统设置-对接设置中填写已运行的url地址即可。 例如:
http://140.143.60.140:8223/
3.3 店铺信息接口
3.3.1 接口鉴权
注:鉴权信息所使用的token和nonce,请在电商版平台端-系统设置-对接设置中获取。
3.3.2 请求头
无
3.3.3 请求参数
例如:
http://140.143.60.140:8223/?token=ezYuHCVU6f1KnqWjpN1TGYDztzBXwzNqiXagyvQtszI×tamp=1586331608718&signature=0a0f24c590e83b330ba6a9b0830baa6f1f6dfb3c&storeId=12345
字段名 | 备注 |
---|---|
token | token |
timestamp | 时间戳 |
nonce | nonce |
storeId | 店铺id |
3.3.4 请求体
无
3.3.5 返回体
{
"data":{
"img":"https://img10.360buyimg.com/n6/jfs/ t1/88425/40/12091/294889/5e414e07Ecbd6b1b0/712bf44595d18f01.jpg", //店铺图片
"tradeType":"电商行业", //店铺类型
"grade":"27", //店铺评分
"userGrade":"9.0", 用户评价
"logisticsGrade":"9.0", //物流时效
"serviceGrade":"9.0" //售后服务等级
}
}
3.3.6 鉴权处理流程
1)获取请求参数token、timestamp 2)根据token查询nonce值 3)按照token、timestamp、nonce的顺序拼接成字符串,使用sha1算法计算signature值 4)和上送的signature值进行匹配,一致则鉴权成功 5)返回商品信息
3.3.7 对接设置
电商版平台端-系统设置-对接设置中填写已运行的url地址即可。 例如:
http://140.143.60.140:8223/
3.4 访客端sdk
可以通过我们提供的访客端sdk,来将电商版功能集成到移动端(ios或安卓app)
电商版访客端sdk下载链接ds_sdk.rar