文档中心 > 智慧门店

云码-纯营销类接口说明

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

一、前置工作

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 判断消费者是否被命中

API名称:tmall.stella.cc.task.charge.launch

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

 

device_sn:运营商设备编码

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

alipay_open_id:支付宝的openid

url_id:可选,urlID

extra:可选,服务商附加url参数

 

若命中,则通过该API的响应获取到动态的拉新营销页url

 

3.3 奇门接口-通知运营商消费者行为

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

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:设备外部编码,运营商自己的设备编码

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:请求唯一标识

 

6 订单信息同步

将设备发生的订单数据回流给天猫,不要求实时回流,保证数据当天回流即可。

API名称:tmall.stella.cc.record.order.sync

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

 

三、奇门接口实现

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

FAQ

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