Appearance
电表充值接口文档
接口链接
URL地址: http://api2.tqdianbiao.com/Api_v2/ele_security/recharge
充值业务流程
接口首次充值问题
接口首次充值问题
背景:
一般新表的使用流程是清零开户充值 但是开发者对接时设备已经通过系统 清零开户过了,此时清零可能会影响用电,不便轻易清零,此时接口直接充值往往容易出错
接入方维护参数
时:
- 可从设备数据 获取设备的 户号 (
account_id
) , 购买次数(count
),作为参数, 后续,遵循参数规则,接入方自行维护. - 获取通过系统开户时的 电价参数 可以在 参数档案 中获取,通过 priceid 关联
- 多费率电价 可在 价格档案 (此接口中用不到)
系统维护参数
时:
- 直接充值 参数由系统维护
接口参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
授权码 | 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字段说明
字段名 | 变量名 | 接入方维护参数 | 系统维护参数 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|---|
充值金额 | money | 必填 | 必填 | String | 100 | |
账户Id | account_id | 必填 | 不填 | String | 1 | 建议始终填1(需跟开户时的参数保持一致) |
充值次数 | count | 必填 | 不填 | String | 2 | 充值次数从2开始,每次充值成功后自增1 首次充值 |
电价 | price | 必填 | 不填 | String | 1 | 单价 范围:0.01-99.9999 ,仅单费率表此字段有效 ,多费率此字段无效 设置多费率电价 |
透支金额 | overdraw | 选填 | 不填 | String | 100 | 透支金额 (电表允许的欠费金额)范围:0-999999 默认:0 |
一级报警金额 | display_warning | 选填 | 不填 | String | 20 | 显示报警金额 (剩余金额低于此值报警灯闪烁)范围 0-999999,默认 100 元 |
二级报警金额 | pulloff_warning | 选填 | 不填 | String | 10 | 断电报警金额 (剩余金额低于此值断电报警,需用合闸命令)范围 0-999999 ,默认 0 元 |
负荷限制功率 | load_limit | 选填 | 不填 | String | 10 | 负荷限制功率 0-99.9999kw 默认 10kw |
超负荷恢复延时 | load_delay | 选填 | 不填 | String | 5 | 超过负荷断电后 延迟上电时间 0-99 分钟 ,默认 5 分钟 |
电表倍率 | rate | 选填 | 不填 | String | 1 | 电表倍率 , 默认1 |
屏幕轮显时间 | display_time | 选填 | 不填 | String | 10 | 屏幕轮显时间 0-99秒 默认5秒 |
参数维护模式 🌟
danger
提示
负荷限制
- 单相表按照规格最大安培数 乘以 电压,例如: 10(40) A的表 可设置最大功率为 40A * 220V = 8.8kw
- 三相表 按照最大规格数 乘以220V再乘以3,例如: 10(40A)的表 可设置最大功率为 40A * 220V * 3 = 26.4kw
- 三相互感式表无需计算互感比 例如: 支持的最大电流为5A,可设置最大功率为 5A * 220V * 3 = 3.3kw
同步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
返回状态码 | 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”时,填入具体的出错内容 |
提示
- 当前接口为异步接口,即请求成功后,系统会通过回调地址把结果推送给请求方。 异步回调
异步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
回复内容 | response_content | 是 | String | 处理结果数据,查询类型不同,包含数据也会有所差异。 |
签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值,详见签名生成算法 |
示例
json
{
"auth_code": "37577f8fb62a7b14ba55cc6faec5a142",
"timestamp": "1586740681",
"request_content": [
{
"opr_id": "f17c5cc33ca947e18e081fc911ed9c08",
"time_out": 0,
"must_online": true,
"retry_times": 1,
"cid": "19020618114",
"address": "000066660942",
"params": {
"account_id": "123456",
"count": "2",
"price": 1.2,
"money": "100"
}
}
],
"notify_url": "http://115.221.11.179:8022/notify",
"sign": "fee536cf6a37a200d6761df04f5bf368"
}
选择 系统维护参数
params字段示例 ⭐
json
{
"money": "100"
}
选择 接入方维护参数
params字段示例 🌟
json
{
"account_id": "123456",
"count": "2",
"money": "100",
"price": 1.2,
"overdraw": "100",
"display_warning": "20",
"pulloff_warning": "10",
"load_limit": "10",
"load_delay": "5",
"rate": "1",
"display_time": "10"
}
常见错误
WARNING
异常提示:84:客户编号不匹配 充值次数错了
异常提示:82:密码错误 户号错误 (未开户直接充值可能会引发此错误)
充值金额不匹配 -- 充值次数重复了,相同充值参数(次数)第二次充值是查询的效果
参数维护模式 🌟