API那些事(一)

1.什么是API

1.1.准确定义

API(Application Programming Interface,应用程序接口)是一些预先定义的接口(如函数、HTTP接口),或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程,而又无需访问源码,或理解内部工作机制的细节。

1.2.类比

API就好像一家公司的电话号码,我们自己完不成或不想去完成的事,打通这个电话号码,然后告诉这家公司你的信息,最后这家公司给你提供你想要的服务。

2.API的意义

API的意义就在于,它让程序员之间可以轻松分工,而分工之后,你只要管好你的业务就可以,任何复杂的不在你领域内的业务,都可以找到对应的API或服务,直接调用即可。利用现有接口可以降低开发成本,缩短开发成本

3.API的形式

3.1.函数形式

很多情况下,如果你在直接使用语言提供的API的话,API的形式可能就是一个函数。

但是还有很多其它的情况,API并不一定是一个函数,有可能是一个类,一个HTTP网络请求(最主要的API,请见下文)等

3.2.网络请求形式

我们现在有一个APP,需要用户在购买的时候调起微信支付的API,完成购买。
a.接口地址

现在Now,用户点击付款,我们需要告诉微信,我们要调起你们的收银台啦!但,去哪里告诉呢?这就需要接口地址了,也就相当于向微信的这条链接传输指定的数据。

一个链接地址不是我们理解的一个页面,你可以理解是一个电话号码,小白们要改变这个观念。
此时我们可以看到接口文档告诉我们链接是如下这条,那我们现在已经拨通微信的电话了。

b.请求参数(报文)

我们现在需要告诉微信,你想调用收银台对吧。那我们需要写下来,此时生成的叫做报文,也就是你想告诉这个接口的内容是什么?相当于前文函数的输入x=2。

一般来说,报文的格式和内容都是按接口文档规定的。如下文就是微信开放平台对调起收银台的报文要求。

我们先来看前2个参数,你现在跟微信在对话,是不是应该先告诉微信,你是谁?这里微信的文档告诉你应该要用应用ID+商户号来确定你的身份,什么意思呢?

比如你是A商户,下面有a,b,c三个APP,所以微信要知道你是哪个商家,下面的哪个APP要用收银台。这是非常重要的,微信后面要把收到的钱打到对应的账户以及统计数据等。

那我们就在报文里面写下这两句话:

<appid>wx2421b1c4370ec43b</appid>(我的应用ID是wx2421…….)
<mch_id>10000100</mch_id>(我的商户号是10000…….)

好了,现在微信知道你是谁了,那你要告诉微信,你需要微信支付帮你收多少钱对吧?这里定义了货币类型和总金额,也就是收什么货币,收多少钱。

这里你看,货币类型的必填写了否,也就是说你也可以不告诉微信支付货币类型是什么,因为他在后面备注了默认是人民币。

好的,那我们写下两段报文

<free_type>CNY</ free_type >(我要收人民币)
<total_fee>1</total_fee>(我要收1元)

好了,现在微信知道你是谁,也知道要收多少钱了,那接下来微信支付要把收钱结果告诉你呀,因为你得知道用户是成功支付了才能继续发货,服务啊等等的。所以这里我们用到通知地址,就是告诉微信,等下完事了他去哪里告诉你支付结果。那我们把地址写好:

<notify_url>http://wxpay.wxutil.com/pub_v2/pay/notify.v2.php</notify_url>

c.返回结果

刚刚微信支付已经去收款了,现在他要在我们留下的通知地址中,告诉我们结果了。结果无非是两种:成功收款?收款不成功?

(1)成功

很顺利,现在用户成功付钱了,并且微信也把成功的消息告诉我们了,并且他还把用户支付的一些信息也告诉我们。
test
那这里就是微信支付成功收款后告诉我们的信息。

应用APPID,商户号:告诉你我成功扣款的是哪家商户的哪个APPID的交易。

业务结果:成功或失败

(2)失败

在产品设计的时候,我们往往很关注失败的情况,当收款失败的时候,微信同时会告诉你失败的原因,如下图很好理解,失败的原因有很多很多种,我们在设计的时候往往要分析每种失败的原因,为每个失败的原因设计页面和用户提示,以确保用户能理解。
ttest

以上就是API接口基本运作模式的理解,下面我将继续更新API接口的一些更为深入和细节的关键元素,如请求方式/签名/加解密等等。

4.参考资料

posted @ 2022-01-07 21:07  曼路的个人博客  阅读(55)  评论(0编辑  收藏  举报