收银审计

1 场景描述

本文档主要是描述针对于IPC对接用户需要使用收银审计功能的对接步骤。基于商米的IPC摄像机和软件商传入的门店订单信息,商米数字店铺的收银审计服务可以针对每笔交易产生收银审计视频。用户可以在商米助手APP内查看,也可以通过接口方式导出到第三方平台进行观看。

2 主要流程

下图的流程描述了需要对接的整个流程和步骤,主要分为几个步骤:

  1. 创建商户/门店以及获得用户授权
  2. 绑定IPC设备到门店
  3. 同步订单数据到商米数字店铺平台
  4. 用户在商米助手上开启收银审计服务
  5. 用户可以通过商米助手APP查看生成的每日收银审计视频
  6. 通过openAPI接口,可以导出收银审计视频到对接的软件平台

3 详细流程

3.1 商户/门店创建

目前商米数字店铺提供两种创建模式,可以通过商米助手APP或商米数字店铺(store.sunmi.com)直接创建,也可以通过openAPI进行商户和门店的创建。

3.1.1 通过商米助手APP和商米数字店铺进行门店创建和授权

您可以从IOS和Android应用市场下载商米助手APP,安装之后进行用户注册和商户创建:

您也可以通过web页面(store.sunmi.com)进行用户和商户的创建。

在商米数字店铺平台创建完成商户和门店之后,要和第三方平台进行授权。用户在数字店铺页面上可以获取门店授权码(24小时内有效)。

在获取到门店编号以及店铺密钥之后,可以通过调用openAPI接口 (/shop/bind)进行门店授权。【接口详情: 商米数字店铺开放平台->店铺绑定和授权->门店接口->4.3.1 绑定商米门店】

3.1.2 通过openAPI接口进行商户和门店的创建

如果您希望通过纯接口的方式进行操作,用户无需手动注册和提供店铺密钥。也可以通过openAPI接口直接创建商户和门店。接口调用顺序如下

  1. 调用创建商户接口 /company/create
  2. 调用创建商户接口 /shop/create, 将门店添加到刚才创建的商户下
    【接口详情: 商米数字店铺开放平台-> 店铺绑定和授权->商户接口->3.3.1 创建商户】
    【接口详情: 商米数字店铺开放平台-> 店铺绑定和授权->门店接口 ->4.3.4 创建门店】

注:通过接口创建的商户和门店无需再次经过授权绑定环节,可以直接使用后续操作。

3.2 绑定IPC设备到门店

商米数字店铺提供了两种设备绑定方法,您可以根据需要选择其中任意一种。

3.2.1 通过商米助手进行IPC绑定门店

您可以在商米助手APP设备页上选择门店并进行设备绑定。绑定完成之后会在设备列表中展示出来。

3.2.2 通过openAPI接口进行IPC绑定门店

您也可以使用openAPI接口直接绑定IPC到指定门店内。调用接口 /device/ipc/bind 。
【接口详情: 商米数字店铺开放平台->智能摄像机IPC->云端API->4.3.4 绑定设备】

3.3 同步订单数据到商米数字店铺

要使用收银审计功能,您需要首先同步订单数据到商米数字店铺。通过以下接口可以进行订单同步操作 /order/create

【接口详情: 商米数字店铺开放平台-> 订单库->3.1.2 创建订单推送接口】

3.4 收银审计服务开通

用户需要在商米助手APP中,选择需要开通收银审计服务的门店和对应设备。

您可以在服务页 -> 收银审计进入收银审计服务。并选择新建服务。

3.5 商米助手查看收银审计视频

当订单正常导入并且服务开通之后,您即可在收银审计服务页面查看每笔订单对应的收银审计视频。

3.6 openAPI获取收银审计视频列表

如果您需要导出收银审计视频,可以通过以下接口: /service/audit/getVideoList
【接口详情: 商米数字店铺开放平台-> 增值服务->3.3.2 获取收银视频列表 】

客流统计和会员到店推送

1 场景描述

本文档主要是描述针对于IPC对接用户需要使用客流统计和会员到店推送等功能所需要的对接过程和步骤。

2 主要流程

下图的流程描述了需要对接的整个流程和步骤,主要分为几个步骤:

  1. 创建商户/门店以及获得用户授权
  2. 绑定IPC设备到门店
  3. 设置和同步人脸库基础数据到门店
  4. IPC设备捕获数据并上传云端
  5. 通过openAPI和消息中心获取相应信息

3 详细流程

3.1 商户/门店创建

目前商米数字店铺提供两种创建模式,可以通过商米助手APP或商米数字店铺(store.sunmi.com)直接创建,也可以通过openAPI进行商户和门店的创建。

3.1.1 通过商米助手APP和商米数字店铺进行门店创建和授权

您可以从IOS和Android应用市场下载商米助手APP,安装之后进行用户注册和商户创建:

您也可以通过web页面(store.sunmi.com)进行用户和商户的创建。

在商米数字店铺平台创建完成商户和门店之后,要和第三方平台进行授权。用户在数字店铺页面上可以获取门店授权码(24小时内有效)。

在获取到门店编号以及店铺密钥之后,可以通过调用openAPI接口 (/shop/bind)进行门店授权。 【接口详情: 商米数字店铺开放平台->店铺绑定和授权->门店接口->4.3.1 绑定商米门店】

3.1.2 通过openAPI接口进行商户和门店的创建

如果您希望通过纯接口的方式进行操作,用户无需手动注册和提供店铺密钥。也可以通过openAPI接口直接创建商户和门店。接口调用顺序如下

  1. 调用创建商户接口 /company/create
  2. 调用创建商户接口 /shop/create, 将门店添加到刚才创建的商户下
    【接口详情: 商米数字店铺开放平台-> 店铺绑定和授权->商户接口->3.3.1 创建商户】
  3. 【接口详情: 商米数字店铺开放平台-> 店铺绑定和授权->门店接口 ->4.3.4 创建门店】

注:通过接口创建的商户和门店无需再次经过授权绑定环节,可以直接使用后续操作。

3.2 绑定IPC设备到门店

商米数字店铺提供了两种设备绑定方法,您可以根据需要选择其中任意一种。

3.2.1 通过商米助手进行IPC绑定门店

您可以在商米助手APP设备页上选择门店并进行设备绑定。绑定完成之后会在设备列表中展示出来。

3.2.2 通过openAPI接口进行IPC绑定门店

您也可以使用openAPI接口直接绑定IPC到指定门店内。调用接口 /device/ipc/bind 。
【接口详情: 商米数字店铺开放平台->智能摄像机IPC->云端API->2.3.4 绑定设备】

3.3 人脸数据导入

要导入和使用人脸信息,您需要经过两步操作:
1)创建或指定人脸分组, 调用创建人脸分组接口 /face/group/create
【接口详情: 商米数字店铺开放平台-> 智能摄像机IPC->云端API->3.3.3 添加人脸分组】

2) 将人脸图片及相关信息添加到人脸分组, 调用添加人脸接口 /face/add
【接口详情: 商米数字店铺开放平台-> 智能摄像机IPC->云端API->5.3.8 向指定人脸分组添加人脸信息】

3.4 设备数据上报

在完成以上操作,并将IPC设备安装完成之后,通过商米助手APP对IPC设备进行基础配置(如进店划线,对焦等操作)。您可以在商米助手和商米数字店铺钟获取多维度客流统计数据。

3.5 接口获取客流数据

如果需要客流数据导出,您可以调用相关的客流openAPI接口。如下图所示:

【接口详情: 商米数字店铺开放平台-> 智能摄像机IPC->云端API->6 人流统计接口】

3.6 实时到店推送

如果您需要实时到店推送信息,可以使用平台提供的消息中心的能力。

如果您想要针对特定门店的人员到店进行推送,可以调用以下openAPI函数注册回调地址: /hook/add
【接口详情: 商米数字店铺开放平台-> 消息中心->消息订阅接口->5.3.1 增加消息监听 】.

具体的回调消息类型以及返回请求的内容,请参考【 商米数字店铺开放平台-> 消息中心-> 智能摄像机IPC事件及消息示例 】

如果您需要为所有门店指定统一的回调地址,请联系我们的技术服务人员,我们会进行后台统一配置。