API接口入门（一）：读懂API接口文档

对许多产品小白或求职者来说，API接口是产品和研发领域的专业术语，你可能在文章或PRD已经接触过API接口概念。

事实上，界面的应用非常广泛和成熟，这一概念主要活跃在公司内部系统之间的连接和对接以及公司之间的合作场景中。如果你能仔细阅读这篇文章，我相信你是对的API对界面的理解会更深入，甚至超过90%的小白和求职者。

本文目录：

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接口的核心点，所有说明文档都离不开这五个核心点。

以下描述以微信开放平台为例。文章末尾有每个开放平台的地址，有空可以学习。好了，还不算晚。现在让我们建立一个场景。

我们现在有一个APP，用户在购买时需要调动微信支付API，完成购买。请自动进入此场景，将自己视为产品经理。

1. 接口地址

现在Now，用户点击付款，我们需要告诉微信，我们需要调动你的收银员！但是，我在哪里可以告诉你呢？这需要接口地址，相当于将指定数据传输到微信链接。

链接地址不是我们理解的页面。你可以理解它是一个电话号码。小白想改变这个想法。

此时，我们可以看到接口文档告诉我们，链接如下，我们现在已经拨打了微信。

2. 请求参数(报文)

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

3. 返回结果

刚才微信支付已经去收钱了，现在他想在我们留下的通知地址告诉我们结果。结果只有两种:成功收款？收款不成功？

（1）成功

非常顺利。现在用户已经成功支付了，微信也告诉了我们成功的消息，他还告诉了我们一些用户支付的信息。

这是微信支付成功收款后告诉我们的信息。

应用APPID，商户号:告诉你我成功扣了哪个商户。APPID的交易。

业务结果：成功或失败：

（2）失败

在产品设计中，我们经常非常关注失败，当收集失败时，微信会告诉你失败的原因，如下图所示，失败的原因有很多，我们经常分析每个失败的原因，因为每个失败的原因设计页面和用户提示，以确保用户能够理解。

以上就是API了解接口的基本操作模式，我将继续更新API一些更深入、更详细的关键元素，如请求方式/签名/加解密等。

开放平台网站可供参考

微信支付：https://pay.weixin.qq.com/wiki/doc/api/index.html

高德平台开放平台：https://lbs.a ** p.com/

本文由 @每个人都是产品经理。未经许可，禁止转载

题图来自Unsplash，基于CC0协议