心跳
接口用途
- 中间件定时与易百后台进行通讯,上报当前状态并同步后台服务器状态,通过后台返回的指令调用相应的接口。
接口地址
https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/heartbeat
action
heartbeat
请求参数,中间件===>易百后台
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
traceNo | String | 是 | 请求流水号 | 不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列 |
transTimestamp | List<transTimestamp> | 是 | 交易时间戳 | 用于统计每笔交易的耗时 |
businessType | int | 否 | 心跳类型 | 0:外卖类; 1:其他类(供可扩展使用) |
请求报文举例
{
"traceNo": "HB99000009100010101732123",
"transTimestamp": [
{
"traceNo":"99000009100010101732123",
"send":"1483372334",
"recv":"1483372335"
},
{
"traceNo":"99000009100010101732125",
"send":"1483372336",
"recv":"1483372337"
}
],
"businessType":0
}
返回参数,易百后台===>中间件
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
traceNo | String | 是 | 请求流水号 | 原样返回 |
transDate | String | 是 | 交易时间 | 格式为:yyyyMMddHHmmss |
returnCode | String | 是 | 返回码 | 00表示交易成功,其他表示失败 |
returnDesc | String | 是 | 返回信息 | 交易结果描述或错误原因 |
nextHeartbeat | Number | 是 | 下次心跳间隔秒数 | |
invokeAction | String | 否 | 调用的接口action | 如:signin 会在当日重新签到 |
alertMessage | String | 否 | 提示信息 | 中间件弹出窗体提示这里返回的信息 |
businessOrderCount | int | 否 | 未处理订单总数 | 用于外卖平台,获取最新未处理订单的总数 |
返回报文举例
{
"traceNo": "99000009100010101732123",
"transDate": "20161231102201",
"returnCode": "00",
"returnDesc": "SUCCESS",
"nextHeartbeat": 10,
"invokeAction": "signin",
"alertMessage": "",
"businessOrderCount":10
}
No Comments