Appearance
水表充值
接口地址
URL地址: http://api2.tqdianbiao.com/Api_v2/water_security/recharge
充值业务流程
接口参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 授权码 | auth_code | 是 | String(32) | 系统为使用区域分配的授权码，在后台配置页面获取 |
| 时间戳 | timestamp | 是 | String(10) | 自1970年1月1日（08:00:00 GMT）至当前时间的总秒数 |
| 请求内容 | request_content | 是 | String | 详见request_content字段说明，注意 request_content 是json数组，注意合并请求⭐ |
| 回调地址 | notify_url | 是 | String | 系统处理完查询请求后，通过这个回调地址，把数据推送给请求方 |
| 签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值，详见签名生成算法 |
请求内容request_content字段说明
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 操作ID | opr_id | 是 | String | 操作ID，长度16-32，请求时自己生成，用于标识一次异步操作任务，须保证唯一性 |
| 采集器号 | cid | 是 | String | 采集器号,4G、NB设备采集器号与表号一致 |
| 表号 | address | 是 | String | 表号（表地址） |
| 超时时间 | time_out | 否 | int | 超时时间 单位秒，任务因通讯异常等情况未执行自动失效的时间 ,默认1年 |
| 是否必须在线 | must_online | 否 | Boolean | 如果传true ,则系统接受任务时设备不在线直接返回失败 ，默认 false |
| 重试次数 | retry_times | 否 | int | 重试次数（0-3） ,默认1次 |
| 操作数据 | params | 是 | json String | 操作所需的数据 |
操作数据params字段说明
| 字段名 | 变量名 | 开启数据同步 | 关闭数据同步 | 类型 | 描述 |
|---|---|---|---|---|---|
| 用水价格 | price | 不填 | 必填 | number | 用水价格，仅充值时购买水量表此字段有效 ，参考水价接口 |
| 充值次数 | count | 不填 | 必填 | number | 充值次数，首次充值为1，每次充值成功后，自增1 |
| 充值金额 | money | 必填 | 必填 | number | 充值金额，在同步模式下，只需要传递money参数 |
同步返回结果
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 返回状态码 | status | 是 | String | SUCCESS/FAIL，此字段是通信标识 |
| 时间戳 | timestamp | 是 | String(10) | 自1970年1月1日（08:00:00 GMT）至当前时间的总秒数 |
| 回复内容 | response_content | 是 | String | 详见response_content字段说明 |
| 签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值，详见签名生成算法 |
| 出错原因 | error_msg | 否 | String | 当返回状态码为"FAIL"时，返回信息为错误原因 |
同步回复内容response_content字段说明
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 操作ID | opr_id | 是 | String | 操作ID，长度16-32，请求时自己生成，用于标识一次异步操作任务，须保证唯一性 |
| 采集器号 | cid | 是 | String | 采集器号,4G、NB设备采集器号与表号一致 |
| 表号 | address | 是 | String | 表号（表地址） |
| 操作状态 | status | 是 | String | 操作请求结果状态，说明提交的任务成功或者失败 |
| 错误信息 | error_msg | 否 | String | 当操作状态：status值不为“SUCCESS”时，填入具体的出错内容 |
提示 ⭐
- 当前接口为异步接口，即请求成功后，系统会通过回调地址把结果推送给请求方。 异步回调
- 水表最小充值单位是0.1吨，不足0.1吨的情况下会提示无效购买量
异步返回结果
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 时间戳 | timestamp | 是 | String(10) | 自1970年1月1日（08:00:00 GMT）至当前时间的总秒数 |
| 回复内容 | response_content | 是 | String | 处理结果数据，查询类型不同，包含数据也会有所差异。 |
| 签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值，详见签名生成算法 |
示例 JSON
[系统维护参数]模式 充值参数
json
...
"params": {
"money": "100"
}json
{
"auth_code": "37577f8fb62a7b14ba55cc6faec5a142",
"timestamp": "1586740681",
"request_content": [
{
"opr_id": "35e5d3a98e954fd89c70448b54c8c158",
"time_out": 0,
"must_online": true,
"retry_times": 1,
"cid": "88020206100",
"address": "C1E81000007859",
"params": {
"price": "5",
"count": "1",
"money": "100" // 注意表类型 参考水价接口
}
}
],
"notify_url": "http://115.221.11.179:8022/notify",
"sign": "fee536cf6a37a200d6761df04f5bf368"
}