从微信支付宝支付接口设计谈API接口产品的设计经验和最佳实践

命令模式和RESTful的抉择

首先,我们查看微信的API,它使用的是类RESTful服务的实现,每个功能都有各自的URI。

微信API的示例如下。

下单:

https://api.mch.weixin.qq.com/pay/unifiedorder

查单:

https://api.mch.weixin.qq.com/pay/orderquery

可见,下单和查单的API具有相同的URI前缀:https://api.mch.weixin.qq.com/pay,各自的后缀为unifiedorder和orderquery。

然后,我们再来查看一下支付宝支付的API的设计,它使用的是命令模式,

所有的功能都使用同一个URI。

统一的URI:

https://openapi.alipay.com/gateway.do

在HTTP协议中,提供了一个方法参数:method,通过方法参数来传递具体使用的功能,不同的方法表示使用不同的操作。

下单:

alipay.trade.pay

查单:

alipay.trade.query

我们看到,支付宝使用命令模式,只提供了一个统一的URI,然后通过method参数来表示具体调用那个功能和操作。

对比微信支付的RESTful服务和支付宝支付的命令模式,各有优缺点。

两种方式的有点如下。

  • 对于命令模式,URI的设计比较简单,只需要设计统一的URI即可,具体选择哪个功能都在method中来表示,method参数易于扩展,扩展时不需要对URI和以及7层代理的URI路由进行修改,只需要对后端代码进行修改即可,对后期增加更多的命令和操作提供了方便。
  • 对于RESTful模式,每个功能和操作都有一个对应的URI,对于开发者来说学习起来比较简单,使用起来比较方便,URI信息是在HTTP头上进行传递的,由于URI的不同,在7层代理可以灵活配置分流和路由,这通常在迁移的过程中是需要的。

我们看到这两种方式各有优点,实际上,命令模式代表中心化的思想,而RESTful模式代表的是分而治之的思想,有的时候优点就是缺点儿,缺点就是优点,其实是个博弈。

命令模式是中心化的思想,比较封闭,虽然对将来的扩展实现比较容易,但是失去了简单易懂的优点。而RESTful是分而治之的思想,保持原汁原味的简单API的风格,看到URI就知道API的功能,简单易懂,方便使用。

这里,通过一个比喻来对比命令模式和RESTful模式,想象一下桌子上有3个杯子,杯子里面装着水、酒、雪碧,看起来都是透明的,如果每个杯子都没有标签,我们得拿起挨个尝一下,才知道哪个是水、酒或者雪碧,这就像命令模式一样,URI长得一样,想知道它是干什么的需要进一步看内部的参数,除了看起来麻烦,这在七层代理分流的时候,也是需要解析HTTP体才能看到method参数,性能偏低,然而,如果我们在杯子上加了标签,我们一眼就看出哪个是水、酒或者雪碧,这就像在7层代理需要分流的时候,直接在HTTP头中获取URI,做不同的事儿。

B2B API的安全策略

API接口属于典型的B2B的产品,对安全的要求比较特殊,需要验证企业的身份,这和用户端APP的安全技术栈不同,B2B的API产品通常通过签名和加密来保证安全。

要实施签名和加密安全策略,通常我们会进行抉择是用签名还是加密呢?用对称加密还是非对称加密?

这还是要从需求说起,安全需求也是需求的一种,我们总结安全需求无非这几种:

  1. 防篡改
  2. 防偷窥
  3. 防泄漏
  4. 防抵赖
  5. 防中间人攻击

要满足这些安全需求,我们采用不同的安全策略和方法,我们从密码学的历史开始说起,这一共经理了3个时代。

  1. 算法加密时代

    在很久以前,没有各种加密算法,为了防止软件被盗用,通常一般在软件中预留了一段加密算法,如果用户输入的注册码满足算法的需求,就通过了校验,这个时代叫做算法加密时代,以算法为核心来验证身份,但是这种方法有明显的缺陷,只要有足够强大的技术力量,算法都是可以被破解的。

  2. 对称加密时代

    这一时代,发明了对称加密算法,加解密方约定同一个秘钥,加密方用密匙加密,解密方用同一个密匙解密,如果可以成功解密,说明加解密方都有权限访问数据。对称加密有两个应用场景,一个就是签名,一个就是用来加密,对称加密和对称签名都是使用的对称加密算法,但是目的不一样,签名就想盖章一样,防止被篡改,而对称加密则是为了防止偷窥和防止泄漏。但是这一时代的对称加密算法也有个明显的缺点,就是加解密双方约定了同一个秘钥,加解密双方理论上都是可以抵赖的,如果秘钥泄露了,对可以说是对方泄露的,是无法判断是谁把秘钥泄露了。

    这一时代著名的算法有3DES、AES。

  3. 非对称加密时代

    到了非对称加密时代,解决了对称加密带来的抵赖问题,这一时代可以生成1对秘钥,1对秘钥由公钥和私钥组成,公钥加密数据只能有私钥来解密,私钥加密数据只能由公钥来解密,前者正式加密的应用场景,而后者是签名的应用场景。著名的SSL就是使用的非对称加密。

    这一时代著名的算法有RSA。

了解了这个背景,我们现在来回顾一开始我们提出的安全需求,要满足防篡改,只需要对称的签名即可,要满足防泄露和防偷窥,只要使用对称的加密即可,但是要满足防止抵赖,必须使用非对称签名和非对称加密。

但是要满足防止中间人攻击,那么,我们需要使用双向的非对称安全验证,通常使用双向的SSL来保证。

在支付行业里面的实践中,为了安全以及合规需求,我们通常需要使用非对称签名来保证数据不被篡改,使用非对称加密保证敏感数据不泄露,如果有出款需求,我们一般使用非对称的双向SSL证书来保证出款的安全。

阅读更多关于“从微信支付宝支付接口设计谈API接口产品的设计经验和最佳实践”的内容,请报名参加gitchat的唠嗑节目。

唠嗑
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容