操作日志

1 基本描述

SaaS合作方可以通过商米数字店铺开放平台获取到业务操作日志

2 接口规范

2.1 协议说明

对接的接口目前只开放HTTPS方式推送消息,所有的消息一律采用POST方式。

Content-Typeapplication/x-www-form-urlencoded
数据格式返回为JSON格式
字符编码UTF-8字符编码
签名算法MD5
签名规则参考2.2 签名规则

2.2 签名规则

参考《鉴权认证》文档。

2.3 公共参数

参数名必填类型说明
app_idstring唯一标识接入身份,联系商米数字店铺提供
randomstring随机字符串,由数字和字母组成,长度范围为6-10位
timestampint当前的unix timestamp,精度到秒级,10位数字
signstring签名信息,详见2.2

3 店铺设计规范

参考《商户店铺》文档。

4 操作日志接口

4.1 操作日志业务范围

操作功能操作内容操作行为
巡店抓拍配置(商户级业务)新建
修改(包含开启/关闭)
删除
巡店模板配置(商户级业务)新建
修改 (包含 开启/关闭 )
删除
巡店巡店计划配置(商户级业务) 新建
删除
  • 备注:使用商户级别业务需要先进行商户级别的商户店铺体系对接

4.2 接口列表

接口名称接口描述
/log/operation/company/getList(待上线)获取操作日志列表

4.3 接口详情

4.3.1 获取商户级操作日志列表(待上线)

接口描述:通过本接口调用,用户可以获取指定商户或者店铺下,指定时间范围内的操作日志列表

请求链接:/log/operation/company/getList

接口版本:v2.0

接口参数:

参数名称是否必须类型说明示例
sunmi_company_nostring商米数字店铺平台的企业编号 560279010307
start_timestring 查询开始时间, Unix时间戳,秒级别 1578969264
end_timestring 查询结束时间, Unix时间戳,秒级别 1579055640
page_num 否 (默认1) 当前页 1
page_size 否  (默认10) 当前页条目数量 10
  • 备注:查询时间范围为90天

请求示例:

"method": "POST",
"url": "https://store.uat.sunmi.com/openapi/log/operation/company/getList",
"headers": {
  "Content-Type": "application/x-www-form-urlencoded"
},
formData: {
  "sunmi_company_no": "560279010307",
  "app_id": "LMWWQVTW4QGCC",
  "timestamp": 1581383983,
  "random": "5dsf6698",
  "sign": "33C18A18282733A71F998BB5A5E4319D"
  "start_time": "1581333970",
  "end_time": "1581363970",
}

返回值:

{
	"data": {
		"total_count": 4,
		"operate_list": [{
				"operate_event": "patrol",
				"operate_event_detail": "patrol.cronjob.update",
				"operate_source": "app",
				"operate_time": 1604375860,
				"operate_payload": {
					"params": {
						"active_status": 1,
						"cronjob_id": 2255,
						"cronjob_name": "45345435",
						"cronjob_type": 2,
						"device_id_list": [
							3634,
							2319
						],
						"period_type": 1,
						"sub_job_list": [{
								"end_time": 0,
								"start_time": 57480,
								"time_duration": 15,
								"time_slot": 0
							},
							{
								"end_time": 0,
								"start_time": 57540,
								"time_duration": 5,
								"time_slot": 0
							}
						],
						"week_day_list": []
					},
					"result": "success"
				}
			},
			{
				"operate_event": "patrol",
				"operate_event_detail": "patrol.cronjob.create",
				"operate_source": "app",
				"operate_time": 1604375899,
				"operate_payload": {
					"params": {
						"cronjob_name": "sd",
						"cronjob_type": 1,
						"device_id_list": [
							2256
						],
						"period_type": 1,
						"sub_job_list": [{
							"end_time": 42840,
							"start_time": 46380,
							"time_slot": 900
						}],
						"week_day_list": []
					},
					"result": "success"
				}
			},
			{
				"operate_event": "patrol",
				"operate_event_detail": "patrol.cronjob.delete",
				"operate_source": "app",
				"operate_time": 1604382092,
				"operate_payload": {
					"params": {
						"job_id_list": [
							2255
						]
					},
					"result": "success"
				}
			},
			{
				"operate_event": "patrol",
				"operate_event_detail": "patrol.cronjob.delete",
				"operate_source": "app",
				"operate_time": 1604392539,
				"operate_payload": {
					"params": {
						"job_id_list": [
							2257
						]
					},
					"result": "success"
				}
			}
		]
	},
	"code": 0,
	"msg": "succeed"
}
  • 备注,相关枚举值如有需要详见具体业务

返回参数说明:

参数说明
operate_list操作列表
operate_event操作事件
operate_event_detail操作详情
operate_source操作来源
operate_time操作时间
operate_payload操作内容
result操作结果

operate_event:

取值说明
patrol巡店业务

operate_event_detail:

取值说明
patrol.cronjob.create创建定时任务
patrol.cronjob.update更新定时任务(包括开启关闭)
patrol.cronjob.delete删除定时任务
patrol.plan.create创建巡店计划
patrol.plan.delete删除巡店计划
patrol.template.create创建考评模板
patrol.template.update更新考评模板 (包括开启关闭)
patrol.template.delete删除考评模板

operate_source:

取值说明
app商米助手
websunmi store页面
mgt商米后端管理平台
openapiopenapi接口调用

错误码:

错误码说明
5041商户组织参数错误
5000数据库错误