1. 說明
此文檔僅適用于新美大側(cè)對(duì)接樂車邦保養(yǎng)項(xiàng)目時(shí)使用
2. 有效期
至2017-03-30
3. 接口說明
3.1 接口地址說明
地址前綴:
生產(chǎn):https://m.lechebang.com/gateway/partner_json/{method}/1618
測(cè)試:https://m.lechebang.cn/gateway/partner_json/{method}/1618
其中method是接口名
3.2 接口列表
接口名稱 | 說明 | 冪等性 |
---|---|---|
cancelOrder | 取消訂單(支付前) | Y |
paymentNotify | 同步支付結(jié)果 | Y |
applyRefund | 申請(qǐng)退款 | Y |
refundNotify | 同步退款結(jié)果 | Y |
notifyReview | 同步訂單點(diǎn)評(píng) | Y |
3.3 安全認(rèn)證
樂車邦方通過對(duì)請(qǐng)求(JSON格式)進(jìn)行簽名驗(yàn)證的方式來(lái)保證接口的安全性(返回?zé)o簽名)玄妈,具體的簽名算法為:
- 在請(qǐng)求參數(shù)列表中乾吻,除去sign字段外,其他(根結(jié)點(diǎn))需要使用到的參數(shù)皆是要簽名的參數(shù)拟蜻。
- 對(duì)JSON根結(jié)點(diǎn)的每一個(gè)屬性按屬性名從0~9, a~z的順序排序绎签,若遇到相同首字母,則看第二個(gè)字母酝锅,以此類推辜御。
- 排序完成之后,再把所有屬性名與值用“=”組成鍵值對(duì)屈张,以“&”字符連接起來(lái)擒权。這串字符串便是待簽名字符串袱巨。
例如對(duì)下面的請(qǐng)求參數(shù)
{appCode:100, timestamp: 1338886946, sign:” 6e8ccf3e7fb18ead4bfd9f41078fd52b”, cityId:10101}
待簽名字符串為:
appCode=100&cityId=10101×tamp=1338886946 - 在待簽名字符串末尾加上簽名用的secret值,密鑰secret由樂車邦提供(測(cè)試使用參照附錄)碳抄。
示例:secret值為“vWdg5jw9BTmLk6S0wsYL”愉老,原待簽名字符串為:appCode=100&cityId=10101×tamp=1338886946
追加secret后得到:
appCode=100&cityId=10101×tamp=1338886946vWdg5jw9BTmLk6S0wsYL - 進(jìn)行md5運(yùn)算,運(yùn)算結(jié)果做uppercase大寫化操作剖效,最終得到簽名嫉入。
對(duì)接方可以下載簽名工具來(lái)計(jì)算和自測(cè)簽名,在聯(lián)調(diào)測(cè)試過程中也可能用到璧尸。
3.4 請(qǐng)求和返回
3.4.1 請(qǐng)求格式
樂車邦接口請(qǐng)求由appCode咒林,時(shí)間戳,簽名爷光,和其他業(yè)務(wù)參數(shù)四個(gè)部分組成:
{
"appCode":1618,
"timestamp":1488524179,
"sign":"3EBAAA2CB74D32DFB422C32829C11813",
//其他參數(shù)
}
新美大的appCode為: 1618
timestamp (時(shí)間戳)為服務(wù)器發(fā)出請(qǐng)求的時(shí)間垫竞,誤差正負(fù) 5 分鐘。
3.4.2 返回格式
{
"costTime":15,
"msg":"ok",
"result":{},
"resultCode":"200",
"statusCode":"200",
"validationErrors":null
}
其中:
字段 | 說明 |
---|---|
statusCode | 狀態(tài)碼蛀序,見附錄錯(cuò)誤碼 |
msg | 錯(cuò)誤消息 |
result | 當(dāng)返回中有業(yè)務(wù)數(shù)據(jù)時(shí)欢瞪,數(shù)據(jù)置于result字段中 |
4. 接口設(shè)計(jì)
4.1 取消訂單(支付前) cancelOrder
業(yè)務(wù)請(qǐng)求參數(shù)
參數(shù)名 | 參數(shù)類型 | 是否必選 | 說明 |
---|---|---|---|
orderId | String | Y | 樂車邦訂單ID |
調(diào)用示例
Request:
{
"appCode":1618,
"orderId":"XXX1000",
"timestamp":1488449177,
"sign":"BEBB7C326A040AD1CE9327D720699453"
}
Response:
{
"costTime":1380,
"msg":"ok",
"result": {},
"resultCode":"200",
"statusCode":"200",
"validationErrors":null
}
4.2 同步支付結(jié)果 paymentNotify
業(yè)務(wù)請(qǐng)求參數(shù)
參數(shù)名 | 參數(shù)類型 | 是否必選 | 說明 |
---|---|---|---|
orderId | String | Y | 樂車邦訂單ID |
payResult | int | Y | 支付結(jié)果, 1:成功, 2:失敗 |
payPrice | String | N | 用戶實(shí)付金額 |
dpPromoPrice | String | N | 點(diǎn)評(píng)的優(yōu)惠價(jià)格 |
調(diào)用示例
Request:
{
"appCode":1618,
"orderId":"XXXX1000",
"payResult":1,
"payPrice":200,
"dpPromoPrice":6,
"timestamp":1488506049,
"sign":"AAB48C53E09D1D4911ACB886094099AC"
}
Response:
{
"costTime":14,
"msg":"ok",
"result": {},
"resultCode":"200",
"statusCode":"200",
"validationErrors":null
}
4.3 申請(qǐng)退款 applyRefund
業(yè)務(wù)請(qǐng)求參數(shù)
參數(shù)名 | 參數(shù)類型 | 是否必選 | 說明 |
---|---|---|---|
orderId | String | Y | 樂車邦訂單ID |
調(diào)用示例
Request:
{
"appCode":1618,
"orderId":"XXX0001",
"timestamp":1488508664,
"sign":"5E398CA68254B0B14CDC1594109EA213"
}
Response:
{
"costTime":13,
"msg":"ok",
"result": {},
"resultCode":"200",
"statusCode":"200",
"validationErrors":null
}
4.4 同步退款結(jié)果 refundNotify
業(yè)務(wù)請(qǐng)求參數(shù)
參數(shù)名 | 參數(shù)類型 | 是否必選 | 說明 |
---|---|---|---|
orderId | String | Y | 樂車邦訂單ID |
refundResult | int | Y | 退款結(jié)果徐裸,1:退款成功遣鼓, 2:退款失敗 |
調(diào)用示例
Request:
{
"appCode":1618,
"orderId":"XXX0001",
"refundResult":1,
"timestamp":1488508881,
"sign":"942A939E7D3EAE3FFBF59AFF66FF1FB4"
}
Response:
{
"costTime":11,
"msg":"ok",
"result": {},
"resultCode":"200",
"statusCode":"200",
"validationErrors":null
}
4.5 同步訂單點(diǎn)評(píng) notifyReview
業(yè)務(wù)請(qǐng)求參數(shù)
參數(shù)名 | 參數(shù)類型 | 是否必選 | 說明 |
---|---|---|---|
orderId | String | Y | 樂車邦訂單ID |
star | int | Y | 點(diǎn)評(píng)星級(jí),區(qū)間[1~5]:1~5級(jí) |
reviewBody | String | Y | 點(diǎn)評(píng)內(nèi)容 |
調(diào)用示例
Request:
{
"appCode":1618,
"orderId":"XXX001",
"star":4,
"reviewBody":"a good shop!",
"timestamp":1488509130,
"sign":"1A7DC6B1BCDB9B8D94A320918704CD8E"
}
Response:
{
"costTime":17,
"msg":"ok",
"result": {},
"resultCode":"200",
"statusCode":"200",
"validationErrors":null
}
5. 附錄
5.1 statusCode返回狀態(tài)碼
狀態(tài)碼(statusCode) | 說明 |
---|---|
200 | 成功 |
501 | 參數(shù)非法或邏輯校驗(yàn)失敗 |
注意:其他狀態(tài)碼待補(bǔ)充
5.2 新美大密鑰
測(cè)試:聯(lián)系樂車邦開發(fā)獲取
生產(chǎn):聯(lián)系樂車邦開發(fā)獲取