API说明
本API返回数据仅支持JSON格式且会对中文进 行unicode
编码,JSON格式返回数据基本格式如下:
{
"errCode": 0,
"errMsg": "OK",
"data": {}
}
其中 errCode
表示请求状态,0表示请求成功, errMsg
为返回信息, data
为请求成功后返回数据;若 errCode
返回不为0,则为对应错误编码, errMsg
为对应错误信息。
注意:
1. 使用本接口时请使用https协议。
2. 使用本接口时请注意控制访问频率,系统限制QPS为1。
3. 本接口仅包含官网返回的基础数据,需解析更多数据请自行处理。
4. 使用本接口前请点击此处申请 appid
和 secret
,申请完后请妥善保存appid和secret,因为其涉及到免费配额的使用及超出后的预付流量费用。因此不建议将接口调用直接放在前端请求中,否则带来的配额超出等问题由申请人自行承担。
5. 由于底层请求函数有流量限制,流量超出后服务提供商会向开发者收费,因此本接口免费配额为每天 1000
次调用,每月 20000
次调用。如预估每月调用量超过该值请联系开发者就超出调用次数后的超出流量费用进行协商预付,费用可随时退还。
6. 因不可抗拒因素导致的系统停用,导致调用本接口的下游系统出现故障,随风飘扬不负任何责任。
请求信息
GET https://free-api.whutech.com/release/card?city=wuh&cardno=8123122726&appid=appid&secret=secret
请求参数
参数 | 样例 | 说明 |
---|---|---|
city | wuh | 查询卡号所属交通卡类型, 对应关系见附录 |
cardno | 8123122726 | 查询卡号 |
appid | appid | 申请到的appid |
secret | secret | 申请到的secret |
返回信息
成功响应示例
{
"errCode": 0,
"errMsg": "OK",
"data": {
"cardno": "8123122726",
"balance": 21,
"records": [{
"time": "2019-04-11 13:42:35",
"type": "储值钱包一般消费",
"amount": 1.6,
"balance": 21
}, {
"time": "2019-04-08 21:48:19",
"type": "储值钱包一般消费",
"amount": 0,
"balance": 25.8
}, {
"time": "2019-04-08 21:35:18",
"type": "储值钱包一般消费",
"amount": 1.6,
"balance": 25.8
}],
"update": "2019年04月16日 00:00:00",
"city": "wuh",
"todayRemain": 999,
"monthRemain": 19999,
"chargeRemain": 0,
"chargeType": "free"
}
}
响应参数
参数 | 类型 | 样例 | 说明 |
---|---|---|---|
cardno | String | 8123122726 | 交通卡号 |
balance | Float | 21 | 卡片当前余额 |
records | Array | [] | 卡片消费记录* |
records.time | String | 2018-12-13 14:12:52 | 消费时间 |
records.type | String | 储值钱包一般消费 | 消费类型 |
records.amount | Float | 1.6 | 消费金额 |
records.balance | Float | 59.3 | 当次刷卡后交通卡剩余金额 |
update | String | 2019年04月16日 00:00:00 | 余额截止时间,并非所有卡类型都有 |
city | String | 8123122726 | 交通卡所属城市代码 |
todayRemain | Number | 999 | 当日剩余免费调用次数配额 |
monthRemain | Number | 19999 | 当月剩余免费调用次数配额 |
chargeRemain | Number | 0 | 当前剩余预付费调用次数配额 |
chargeType | String | free dayexceed|monthexceed | 本次调用的费用类型(free免费,dayexceed当天超出免费配额收费,monthexceed当月超出免费配额收费) |
*若传入的交通卡提供消费记录信息,则接口返回的json内 data
会包含 records
对象,否则 data
仅包含 cardno
, balance
属性
失败响应示例
{
"errCode": "404",
"errMsg": "未能查询到该卡号数据!"
}
{
"errCode": "404",
"errMsg": "appid或secret错误"
}
{
"errCode": "500",
"errMsg": "输入错误,缺少参数!"
}
附录
交通卡所属代码
参数 | 类型 |
---|---|
pek | 北京市政交通一卡通 |
sha | 上海公共交通卡 |
wuh | 武汉城市一卡通 |
gft | 广佛一卡通 |
szv | 苏州市民卡 |
lnt | 广东岭南通 |
can | 广州羊城通 |
cgo | 郑州绿城通 |
ckg | 重庆畅通卡 |
ctu | 成都天府通 |
tao | 青岛琴岛通 |
tsn | 天津城市通 |
xmn | 厦门E通卡 |
dgm | 东莞通 |
szx | 深圳通 |
hgh | 杭州通 |
作者:@随风飘扬
2019年2月1日