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日