文档中心 > 智慧门店

云码-支付类设备接口说明

更新时间:2019/11/01 访问次数:6124

一、前置工作

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)设备状态回流
至少每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)

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

二、接口实现

时序图

 

 

1.2 动态二维码生成规则

云码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)即可

 

2.2/3.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", "扫码"), action("action", "授权入会/关注")

promotionPrice:平台权益金额

outerCode:对应1.2中传入的deviceSn

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

 

4.1 通知运营商创建支付宝订单

SPI名称:qimen.tmall.cloudcode.alipaytrade.create

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

 

1)天猫云码:通知运营商创建订单。通SPI接口的请求参数将支付宝用户ID、权益金额等信息传过来

2)运营商:调用支付宝API创建订单。

3)运营商:通过SPI接口的响应参数,将支付宝订单号、订单金额(扣除平台权益金额后的结果) 回传给天猫云码

4)天猫云码:根据支付宝用户ID、支付宝订单号、支付宝订单金额  在手淘内拉起支付宝收银台,引导消费者确认支付。

 

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

deviceType:设备类型

deviceCode:平台设备编码

alipayUid:支付宝用户ID

queryStr:云码url参数透传

promotionPrice:平台权益金额

outerCode:对应1.2中传入的deviceSn

version:请求唯一标识

 

 

可选实现的接口

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

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

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

 

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

三、奇门接口实现

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

四、动态CPS链接

如果需要同时接入云码的CPS模式,并且由运营商控制跳转至平台的CPS页面,请用以下拼接方式。运营商只需要负责跳转至云码的指定入口(见3.2),然后由云码平台引擎判断跳转至具体的CPS页面,具体的CPS页面由小二后台配置。

3.1 特性介绍
1.支持基于LBS(设备所属场景)投放不同的CPS内容(比如不同的商品组合等)
2.平台小二基于运营效果切换CPS链接,而运营商不用修改产品上链接

3.2 动态CPS入口链接拼接规则
https://jupiter.taobao.com/cc/scan?deviceSn=XXX&channelId=XXX&skipPromotion=true&stellaLinkPath=afterpay

4个必传参数说明:
deviceSn:传运营商对应的设备编码,请务必传准确,否则会影响到lbs投放精准以及运营分析数据
channelid:传运营商对应的appkey
skipPromotion:固定传"true",用于控制跳转链路
stellaLinkPath:固定传 "afterpay",用于控制跳转链路

FAQ

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