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接口的中心点，一切的分析文档离不开这5个中心点。
以下分析均以微信开放平台为例分析，文末有各开放平台的地点，各位有空可以去学习。好了，燃眉之急，如今我们来创建一个场景。
我们如今有一个APP，必要用户在置办的时分调起微信付出的API，完成置办。请列位主动进入这个场景，把本人当作一位产物司理。
1. 接口地点
如今Now，用户点击付款，我们必要报告微信，我们要调起你们的收银台啦！但，去何处报告呢？这就必要接口地点了，也就相当于向微信的这条链接传输指定的数据。
一个链接地点不是我们了解的一个页面，你可以了解是一个电话号码，小白们要改动这个看法。
此时我们可以看到接口文档报告我们链接是如下这条，那我们如今以前拨通微信的电话了。
2. 哀求参数（报文）
我们如今必要报告微信，你想调用收银台对吧。那我们必要写下去，此时天生的叫做报文，也就是你想报告这个接口的内容是什么？相当于前文函数的输入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>
3. 前往后果
刚刚微信付出以前去收款了，如今他要在我们留下的关照地点中，报告我们后果了。后果无非是两种：告捷收款？收款不告捷？
（1）告捷
很顺遂，如今用户告捷付钱了，并且微信也把告捷的消息报告我们了，并且他还把用户付出的一些信息也报告我们。
那这里就是微信付出告捷收款后报告我们的信息。
使用APPID，商户号：报告你我告捷扣款的是哪家商户的哪个APPID的买卖。
业务后果：告捷或失败
（2）失败
在产物计划的时分，我们屡屡很眷注失败的情况，当收款失败的时分，微信同时会报告你失败的缘故，如下图很好了解，失败的缘故有很多很多种，我们在计划的时分屡屡要分析每种失败的缘故，为每个失败的缘故计划页面和用户提示，以确保用户能了解。
以上就是API接口基本运作形式的了解，底下我将持续更新API接口的一些更为深化和细节的紧张元素，如哀求办法/署名/加解密等等。
可供参考的开放平台网站
微信付出：
https://pay.weixin.qq.com/wiki/doc/api/index.html
高德平台开放平台：https://lbs.amap.com/
本文由 @就是爱睡觉 原创公布于各位都是产物司理。未经允许，克制转载
题图来自Unsplash，基于CC0协议
