新美大对接乐车邦保养接口文档

1. 说明

此文档仅适用于新美大侧对接乐车邦保养项目时使用

2. 有效期

至2017-03-30

3. 接口说明

3.1 接口地址说明

地址前缀:
生产:https://m.lechebang.com/gateway/partner_json/{method}/1618
测试:https://m.lechebang.cn/gateway/partner_json/{method}/1618
其中method是接口名

3.2 接口列表

接口名称 说明 幂等性
cancelOrder 取消订单(支付前) Y
paymentNotify 同步支付结果 Y
applyRefund 申请退款 Y
refundNotify 同步退款结果 Y
notifyReview 同步订单点评 Y

3.3 安全认证

乐车邦方通过对请求(JSON格式)进行签名验证的方式来保证接口的安全性(返回无签名),具体的签名算法为:

  1. 在请求参数列表中,除去sign字段外,其他(根结点)需要使用到的参数皆是要签名的参数。
  2. 对JSON根结点的每一个属性按属性名从0~9, a~z的顺序排序,若遇到相同首字母,则看第二个字母,以此类推。
  3. 排序完成之后,再把所有属性名与值用“=”组成键值对,以“&”字符连接起来。这串字符串便是待签名字符串。
    例如对下面的请求参数
    {appCode:100, timestamp: 1338886946, sign:” 6e8ccf3e7fb18ead4bfd9f41078fd52b”, cityId:10101}
    待签名字符串为:
    appCode=100&cityId=10101&timestamp=1338886946
  4. 在待签名字符串末尾加上签名用的secret值,密钥secret由乐车邦提供(测试使用参照附录)。
    示例:secret值为“vWdg5jw9BTmLk6S0wsYL”,原待签名字符串为:appCode=100&cityId=10101&timestamp=1338886946
    追加secret后得到:
    appCode=100&cityId=10101&timestamp=1338886946vWdg5jw9BTmLk6S0wsYL
  5. 进行md5运算,运算结果做uppercase大写化操作,最终得到签名。
    对接方可以下载签名工具来计算和自测签名,在联调测试过程中也可能用到。

3.4 请求和返回

3.4.1 请求格式

乐车邦接口请求由appCode,时间戳,签名,和其他业务参数四个部分组成:

{
    "appCode":1618,
    "timestamp":1488524179,
    "sign":"3EBAAA2CB74D32DFB422C32829C11813",
    //其他参数
}

新美大的appCode为: 1618
timestamp (时间戳)为服务器发出请求的时间,误差正负 5 分钟。

3.4.2 返回格式

{
    "costTime":15,
    "msg":"ok",
    "result":{},
    "resultCode":"200",
    "statusCode":"200",
    "validationErrors":null
}

其中:

字段 说明
statusCode 状态码,见附录错误码
msg 错误消息
result 当返回中有业务数据时,数据置于result字段中

4. 接口设计

4.1 取消订单(支付前) cancelOrder

业务请求参数

参数名 参数类型 是否必选 说明
orderId String Y 乐车邦订单ID

调用示例

Request:

{
    "appCode":1618,
    "orderId":"XXX1000",
    "timestamp":1488449177,
    "sign":"BEBB7C326A040AD1CE9327D720699453"
}

Response:

{
    "costTime":1380,
    "msg":"ok",
    "result": {},
    "resultCode":"200",
    "statusCode":"200",
    "validationErrors":null
}

4.2 同步支付结果 paymentNotify

业务请求参数

参数名 参数类型 是否必选 说明
orderId String Y 乐车邦订单ID
payResult int Y 支付结果, 1:成功, 2:失败
payPrice String N 用户实付金额
dpPromoPrice String N 点评的优惠价格

调用示例

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 申请退款 applyRefund

业务请求参数

参数名 参数类型 是否必选 说明
orderId String Y 乐车邦订单ID

调用示例

Request:

{
    "appCode":1618,
    "orderId":"XXX0001",
    "timestamp":1488508664,
    "sign":"5E398CA68254B0B14CDC1594109EA213"
}

Response:

{
    "costTime":13,
    "msg":"ok",
    "result": {},
    "resultCode":"200",
    "statusCode":"200",
    "validationErrors":null
}

4.4 同步退款结果 refundNotify

业务请求参数

参数名 参数类型 是否必选 说明
orderId String Y 乐车邦订单ID
refundResult int Y 退款结果,1:退款成功, 2:退款失败

调用示例

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 同步订单点评 notifyReview

业务请求参数

参数名 参数类型 是否必选 说明
orderId String Y 乐车邦订单ID
star int Y 点评星级,区间[1~5]:1~5级
reviewBody String Y 点评内容

调用示例

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返回状态码

状态码(statusCode) 说明
200 成功
501 参数非法或逻辑校验失败

注意:其他状态码待补充

5.2 新美大密钥

测试:联系乐车邦开发获取
生产:联系乐车邦开发获取

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,265评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,274评论 1 288
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,087评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,479评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,782评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,218评论 1 207
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,594评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,316评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,955评论 1 237
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,274评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,803评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,177评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,732评论 3 229
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,953评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,687评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,263评论 2 267
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,189评论 2 258

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,083评论 18 139
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,465评论 6 13
  • 22年12月更新:个人网站关停,如果仍旧对旧教程有兴趣参考 Github 的markdown内容[https://...
    tangyefei阅读 35,125评论 22 257
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,292评论 18 399
  • 凌晨,暴雨已停歇 挣钱的机器还在滔滔不绝 被夜侵袭过的路上堆满垃圾 工人的宿舍楼依然面如死灰 与市中心的干净整洁格...
    清水浮萍阅读 249评论 0 2