实际上,接口的运用已经非常广泛和成熟,这个观点紧张生动在公司内部的各系统之间的衔接和对接以及公司间互助的场景。
如果你可以负责看完这篇文章,我相信你们对API接口的认识会更深入,乃至超过90%的小白和求职者。

本文目录:

API接口是什么?为什么我们须要API接口?API接口的核心

php接口apiAPI接口入门一读懂API接口文档 jQuery

一、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协议