文档中心 > 智慧门店

云码-共享充电宝接口说明

更新时间:2019/10/11 访问次数:3389

一、前置工作

1)已完成淘宝开放平台入驻,拿到appkey
参考:https://open.taobao.com/doc.htm?docId=112264&docType=1

2)设备注册
需要将现有的设备信息注册到天猫云码平台
API名称:tmall.stella.cc.device.register( 码上抢设备注册接口 )
API文档:https://open.taobao.com/api.htm?docId=46684&docType=2

参数说明:
device_sn:设备外部编码,运营商自己的设备编码
device_type:设备类型,枚举值见附录 https://open.taobao.com/doc.htm?docId=118309&docType=1
primary_scene:设备点位所属的一级场景,枚举值见附录 https://open.taobao.com/doc.htm?docId=118309&docType=1
secondary_scene:设备点位所属的二级场景,枚举值见附录 https://open.taobao.com/doc.htm?docId=118309&docType=1
address:设备点位所在的详细地址(需包含省市区街道门牌号,确保高德地图可识别)

3)设备查询API(可选实现)
API名称:tmall.stella.cc.device.status.query( 查询设备状态 )
API文档:https://open.taobao.com/api.htm?docId=46017&docType=2

二、接口实现

时序图

0 设备状态回流

至少每24小时内回流一次设备状态

API名称:tmall.stella.cc.device.status.update

API文档:https://open.taobao.com/api.htm?docId=44316&docType=2&scopeId=15276

 

status:设备状态。NORMAL,BROKEN

device_sn:运营商设备编码

channel_id:传入运营商的渠道ID(在这里就是appkey)

 

1.2 云码动态URL拼接规则

云码URL规则:https://jupiter.taobao.com/cc/scan?channelId=${channelId}&deviceSn=${deviceSn}&commodityId=xxx&salePrice=100&v=1542858210000

 

channelId:传入运营商的appkey

deviceSn:设备外部编码,运营商自己的设备编码

commodityId:商品ID(可选参数)

salePrice:商品销售价格(可选参数)

v:版本号,传入当前时间戳(Unix Timestamp)即可

 

1.3/2.2 通知运营商消费者行为

天猫将消费者的行为动作同步给运营商

SPI名称:qimen.tmall.cloudcode.business.notify

SPI文档:https://open.taobao.com/api.htm?docId=42308&docType=2

 

version:请求唯一标识

holderId:用户openId,用户在淘宝的唯一标识

deviceCode:平台设备编码

phase:消费者行为枚举。scan("scan", "打开CPA页面"), action("action", "拉新")

promotionPrice:平台权益金额

outerCode:对应1.2中传入的deviceSn

queryStr:云码url参数透传,eg:channelId=${channelId}&deviceSn=${deviceSn}&commodityId=xxx&salePrice=100&v=1542858210000

 

权益发放:在收到 phase=action的notify消息后,由运营商自行给消费者派发现金抵扣券。

 

 

可选实现的接口

API用途:云码设备圈选情况查询,判断设备是否被云码投放计划圈选

API名称:tmall.stella.cc.device.circle.check

API文档:https://open.taobao.com/api.htm?docId=44315&docType=2&scopeId=15276

 

服务商实现这个api,判断要不要该设备上是否透出云码。如果判断被圈中了,一定要透出。

 

三、奇门SPI接口实现

参考文档:https://open.taobao.com/doc.htm?docId=116667&docType=1

FAQ

关于此文档暂时还没有FAQ
返回
顶部