open.passengerflow.reportPassengerFlow (上报进店客流)
按时间累加到每个门店的小时数据
接口描述#
环境 | 接口方法 | 提交方式 | 是否需要签名 | HTTP请求路由 |
---|---|---|---|---|
正式环境 | open.passengerflow.reportPassengerFlow | GET | true | http://cloudapi.ovopark.com/cloud.api |
公共请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
_aid | String | 是 | 20 | 开放平台系统编号,固定为S107 | S107 |
_akey | String | 是 | 20 | 万店掌开放平台分配给第三方的开发者key | 认证平台开发者后获取 |
_mt | String | 是 | 100 | 接口名称 | open.passengerflow.reportPassengerFlow |
_sm | String | 是 | 100 | 签名算法 md5,sha1 | md5 |
_requestMode | String | 是 | 100 | 请求方式post,get | GET |
_version | String | 是 | 100 | 版本号 | v1 |
_timestamp | String | 是 | 100 | 时间戳 | yyyyMMddHHmmss格式 |
_sig | String | 是 | 32 | 签名token | 根据签名算法生成,详情见签名算法规则 |
_format | String | 否 | 10 | format类型 | 目前默认仅支持json |
业务请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
enterpriseId | int | √ | 10 | 业务平台企业id | 11 |
peoplecount | int | √ | 10 | 就餐人数 | 22 |
createTime | int | √ | 10 | 统计时间(yyyy-MM-dd HH:mm:ss格式) | 2019-08-21 12:23:34 |
depId | int | × | 10 | 业务平台门店id(depId与shopId二者必须传1个,优先级depId>shopId) | 123 |
shopId | int | × | 10 | 业务平台门店编码(depId与shopId二者必须传1个,优先级depId>shopId) | 321 |
公共响应参数#
参数 | 类型 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|
stat | JSON | - | 网关状态(具体参数描述如下:) | 查看 |
stat.cid | String | 100 | http请求的标识符 | |
stat.code | String | 100 | 网关返回码 | |
stat.codename | String | 100 | 网关返回码名称 | |
stat.systime | String | Long | 接口调用的当前时间 | |
result | String | 100 | 接口返回提示信息 | |
data | JSON | - | 接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义) | 查看 |
业务返回参数#
参数名称 | 类型 | 是否一定返回 | 返回最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
isError | int | × | 10 | false | isError false 上报成功 |
公共返回码#
返回码名称 | 返回码 | 返回码描述 | 解决方案 |
---|---|---|---|
SUCCESS | 0 | 调用成功 | |
KEY_NOTNULL | 1 | _akey和不能为空 | 接口调用时传入_akey参数 |
KEY_UNLAWFUL | 2 | _akey不合法 | key是非法的,传入正确的key |
KEY_HAS_EXPIRED | 3 | _akey已过期 | 请续订服务或联系平台管理人员 |
SIGN_METHOD_NOTNULL | 4 | _sm参数不能为空 | 接口调用时传入_sm参数 |
SIGN_TYPE_NOTEXIST | 5 | _sm类型不存在 | 目前仅支持md5,sha1 |
SIGN_NOTNULL | 6 | _sig参数不能为空 | 接口调用时传入_sig参数 |
SIGN_WRONG | 7 | 无效的签名,请检查参数和签名格式 | _sig值根据签名算法生成 |
METHOD_NOTNULL | 8 | _mt参数不能为空 | 接口调用时传入_mt参数 |
METHOD_NOTEXIST_CODE | 9 | _mt对应的方法名不存在或未注册进服务 | 检查_mt方法名和_version版本号对应的方法是否传入错误 |
REQUESTMODE_NOTNULL | 10 | _requestMode参数不能为空 | 接口调用时传入_requestMode参数 |
APPLICATIONID_NOTNULL | 11 | _aid参数不能为空 | 接口调用时传入_aid参数 |
APPLICATIONID_NOTSAME | 12 | _aid与当前key不匹配 | _aid与_akey必须一一对应 |
VERSION_NOTNULL | 13 | _version版本号不能为空 | 接口调用时传入_version参数 |
TIMESTAMP_NOTNULL | 14 | _timestamp时间戳不能为空 | 接口调用时传入_timestamp参数 |
TIMESTAMP_FORMAT_ERROR | 15 | _timestamp时间戳格式化错误 | 按照yyyyMMddHHmmss格式 |
TIMESTAMP_OVERTIME | 16 | _timestamp已失效 | _timestamp每次接口调用时重新生成 |
FORMAT_TYPE_NOTEXIST | 17 | _format类型不存在 | 目前仅支持json(默认),xml |
API_CALL_REPEAT | -100 | 接口重复调用 | 接口平台调用异常 |
API_SYSTEM_CALL_ERROR | -500 | api调用失败,系统发生异常 | 接口平台调用异常 |
UNKNOWN_ERROR | -999 | 开放平台系统异常 | 重新发起请求 |
业务返回码#
返回码名称 | 返回码 | 返回码描述 |
---|---|---|
OPEN_USER_IS_NULL | 206001 | 开放平台用户不存在 |
SALES_REPEATED_SUBMISSIONL | 208001 | 就餐人数重复提交 |
DATE_FORMAT_ERROR | 208006 | 日期格式化错误,请按照文档指定的格式上报 |