1 概述
为了方便Saas合作伙伴可以直接在其平台上开通商米提供的所有增值业务,平台提供了服务开通接口。Saas合作伙伴可以通过接口调用直接对相关服务进行开通。
关于计费模式,目前已支持认证码模式。
2 接口规范
2.1 协议说明
对接的openAPI接口目前只开放HTTPS方式,所有的消息一律采用POST方式。
注:消息体大小不得超过1M,超过1M的请求,直接拒绝!
Content-Type | application/x-www-form-urlencoded |
---|---|
数据格式 | 返回为JSON格式 |
字符编码 | UTF-8字符编码 |
签名算法 | MD5 |
签名规则 | 参考2.2 签名规则 |
2.2 签名规则
参考《鉴权认证》文档。
2.3 公共参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
app_id | 是 | string | 唯一标识接入身份,联系商米数字店铺提供 |
random | 是 | string | 随机字符串,由数字和字母组成,长度范围为6-10位 |
timestamp | 是 | int | 当前的unix timestamp,精度到秒级,10位数字 |
sign | 是 | string | 签名信息,详见2.2 |
3 收银视频服务接口
3.1 接口描述
服务订阅接口用来订阅和管理Saas合作方订阅的收银视频服务。
3.2 接口列表
接口名称 | 接口描述 |
---|---|
/service/audit/getVideoList | 获取收银视频列表 |
3.3 接口详情
3.3.1 获取收银视频列表
接口描述: 用户可以通过该接口获取在指定门店下收银视频服务
请求链接:/service/audit/getVideoList
接口版本: v2.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 |
---|---|---|---|
sunmi_shop_no | 否 | string | 商米数字店铺平台门店唯一编号(v2.0之后为必填项) |
shop_id | 否 | string | 店铺在SaaS软件体系下的唯一标识(此参数为后向兼容v2.0之前版本的字段,在v2.0及以后版本使用sunmi_shop_no替代,作为门店唯一标识即可) |
ipc_id | 是 | string | IPC 设备唯一编号 |
start_time | 是 | int | 交易开始时间搜索范围起始日,单位为秒,闭区间(包含该时间) |
end_time | 是 | int | 交易开始时间搜索范围结束日,单位为秒,开区间(不包含该时间) |
page_num | 否 (默认1) | int | 当前页码 |
page_size | 否 (默认10) | int | 当前页条目数量 |
返回值:
{
"code": 1,
"msg": "",
"data": {
"audit_video_list": [{
"order_id" : "B12019060414421630291",
"video_id": "549755813351",
"video_url": "http://test.cdn.sunmi.com/VIDEO/abcdefgh.flv",
"snapshot_url": "http://test.cdn.sunmi.com/VIDEO/abcdefgh.flv?*********",
"purchase_time": 1565235765,
"start_time": 1565235760,
"end_time": 1565235770,
"amount": 30.12,
"ipc_id": "549755811465",
"ipc_sn": "SS101D8BS09178"
}],
"total_count": 1
}
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
order_id | string | 订单号 |
video_id | string | 收银视频id |
video_url | string | 收银视频地址 |
snapshot_url | string | 收银视频截图地址 |
purchase_time | integer | 订单支付时间 |
start_time | integer | 收银视频开始时间 |
end_time | integer | 收银视频结束时间 |
amount | float64 | 支付金额 |
ipc_id | string | ipc设备id |
ipc_sn | string | ipc设备sn |
错误时返回:
{
"code":1,
"data":{},
"msg":""
}
错误列表:
错误编号 | 错误原因 |
---|---|
5000 | 数据库错误 |
5041 | 非法SaaS厂商 |