收银审计

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 绑定商米门店】

如果需要对企业下多家或所有门店进行授权,除了通过接口对每一家门店进行绑定外,商米数字店铺平台还支持页面直接录入第三方的门店对接信息。

如果要采用这种方式进行授权,需要预先绑定企业。 接口调用顺序如下:

1 调用 /company/bind: 【接口详情:商米数字店铺开放平台/组织门店与用户/企业接口/3.3.4 绑定授权商米企业】

获取企业对接凭证的路径如下:

完成企业绑定之后,就可以通过商米数字店铺页面进行门店绑定,

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 获取收银视频列表 】