接口是什么

API接⼝⼊门（⼀）：读懂API接⼝⽂档

本⽂⽬录：

API接⼝是什么？

为什么我们需要API接⼝？

API接⼝的核⼼

⼀、API接⼝是什么？

我们来以⼀个常见的数学公式理解API，⽐如y=x+2，当x=2的时候，y=4，对么？

那此时，我们把y=x+2称为接⼝，x=2称为参数，y=4称为返回结果，那这个接⼝的功能就是能把我们输⼊的数加上2（注意：这⾥你可以发现接

⼝⾃⾝是带有逻辑的）。

类⽐地，我们来理解⼀个常见的场景，⽐如现在有⼀个可以把经纬度转化为城市的接⼝，那当我输⼊经度是55°，纬度是88°的时候，接⼝通过

⾃⼰的逻辑运算，返回结果告诉我：杭州市。

这样你就可以清晰地了解百度百科的官⽅解释了，接⼝就是预先定义的函数逻辑，他是供其他系统请求，然后返回结果的⼀个东西。

⼆、为什么我们需要API接⼝？

背景：我们的业务系统涉及多⽅多⾯，如果要⼀个公司或者⼀个系统把所有业务都做完，那未免⼯作量太⼤了吧？并且如果其他系统或公司有更好

的运算逻辑，那我们在设计功能的时候可以考虑利⽤接⼝进⾏开发。

核⼼需求：利⽤现有接⼝可以降低开发成本，缩短开发成本。

举个例⼦：⽐如我是打车的APP，现在我需要在我的页⾯上展现地图的功能，对于我司⽽⾔，新做地图功能未免成本过⾼，那我们可以在⾼德开

放平台或者百度地图的开放平台，找到地图API，这样的话我们只需要购买⾼德的服务，部署调⽤⾼德地图API，这样就可以快速在我们页⾯上线

地图功能了。

三、API接⼝的核⼼

对于⼩⽩⽽⾔，初看API⽂档可能是⼀头雾⽔的——从哪⾥看，怎么看，看什么是摆在⾯前的问题。

其实对于产品经理⽽⾔，我们应该更关注这个公司可以提供什么样的API接⼝服务，⽐如我知道⾼德可以提供地图API，规划路线的API，这样的

话在我们设计功能和⼯作中就可以想到调⽤他们的服务或者参考。

所以产品⼩⽩们看不懂也不⽤过于担⼼，未来⼯作中你也会更深⼊了解清楚，因为看懂并不复杂，以下是API接⼝的核⼼点，所有的说明⽂档离不

开这5个核⼼点。

以下说明均以微信开放平台为例说明，⽂末有各开放平台的地址，⼤家有空可以去学习。好了，事不宜迟，现在我们来建⽴⼀个场景。

我们现在有⼀个APP，需要⽤户在购买的时候调起微信⽀付的API，完成购买。请各位⾃动进⼊这个场景，把⾃⼰当作⼀位产品经理。

1.接⼝地址

现在Now，⽤户点击付款，我们需要告诉微信，我们要调起你们的收银台啦！但，去哪⾥告诉呢？这就需要接⼝地址了，也就相当于向微信的这

条链接传输指定的数据。

⼀个链接地址不是我们理解的⼀个页⾯，你可以理解是⼀个电话号码，⼩⽩们要改变这个观念。

此时我们可以看到接⼝⽂档告诉我们链接是如下这条，那我们现在已经拨通微信的电话了。

2.请求参数（报⽂）

我们现在需要告诉微信，你想调⽤收银台对吧。那我们需要写下来，此时⽣成的叫做报⽂，也就是你想告诉这个接⼝的内容是什么？相当于前⽂函

数的输⼊x=2。

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

我们先来看前2个参数，你现在跟微信在对话，是不是应该先告诉微信，你是谁？这⾥微信的⽂档告诉你应该要⽤应⽤ID+商户号来确定你的⾝

份，什么意思呢？

⽐如你是A商户，下⾯有a，b，c三个APP，所以微信要知道你是哪个商家，下⾯的哪个APP要⽤收银台。这是⾮常重要的，微信后⾯要把收到的

钱打到对应的账户以及统计数据等。

那我们就在报⽂⾥⾯写下这两句话：

wx2421b1c4370ec43b（我的应⽤ID是wx2421…….）

10000100（我的商户号是10000…….）

好了，现在微信知道你是谁了，那你要告诉微信，你需要微信⽀付帮你收多少钱对吧？这⾥定义了货币类型和总⾦额，也就是收什么货币，收多少

钱。

这⾥你看，货币类型的必填写了否，也就是说你也可以不告诉微信⽀付货币类型是什么，因为他在后⾯备注了默认是⼈民币。

好的，那我们写下两段报⽂

CNY（我要收⼈民币）

1（我要收1元）

好了，现在微信知道你是谁，也知道要收多少钱了，那接下来微信⽀付要把收钱结果告诉你呀，因为你得知道⽤户是成功⽀付了才能继续发货，服

务啊等等的。所以这⾥我们⽤到通知地址，就是告诉微信，等下完事了他去哪⾥告诉你⽀付结果。那我们把地址写好：

3.返回结果

刚刚微信⽀付已经去收款了，现在他要在我们留下的通知地址中，告诉我们结果了。结果⽆⾮是两种：成功收款？收款不成功？

（1）成功

很顺利，现在⽤户成功付钱了，并且微信也把成功的消息告诉我们了，并且他还把⽤户⽀付的⼀些信息也告诉我们。

那这⾥就是微信⽀付成功收款后告诉我们的信息。

应⽤APPID，商户号：告诉你我成功扣款的是哪家商户的哪个APPID的交易。

业务结果：成功或失败

（2）失败

在产品设计的时候，我们往往很关注失败的情况，当收款失败的时候，微信同时会告诉你失败的原因，如下图很好理解，失败的原因有很多很多

种，我们在设计的时候往往要分析每种失败的原因，为每个失败的原因设计页⾯和⽤户提⽰，以确保⽤户能理解。

以上就是API接⼝基本运作模式的理解，下⾯我将继续更新API接⼝的⼀些更为深⼊和细节的关键元素，如请求⽅式/签名/加解密等等。

可供参考的开放平台⽹站