老手产品经理必学技术接口文档常识

lovefengrui

在日常任务中，产品经理需求与多方进行沟通合作，那末掌握相干根底常识关于单方的沟通可以更为顺畅。本文总结了老手产品经理必学技术接口文档常识，便利进一步与开发技术进行合作，但愿对你有所帮忙。

25nll2bczsg.jpg

产品经理需不需求懂技术接口文档？这个问题我感觉就跟问产品经理需不需求懂技术是同样的，而我的倡议是，需求懂，但只需求无限度地懂。明天我结合以前的一些名目教训，以对接电子发票中的开具发票接口为例，分享产品经理怎么学会看懂技术接口文档。
本文是以产品经理了解的角度去阐明和解构接口文档，可能在技术角度未必是正确的，假如有卧底的开发大佬，还请勿喷！
一、甚么是接口文档
要学会看接口文档，首先得明确甚么是接口文档，接口文档的作用是甚么。
跟着开发技术的开展，渐渐开展成为先后端别离的开发形式，简略讲就是前端开发工程师和后端开发工程师各自开发属于本人规模的内容，最初经过 api 接口来进行先后端信息的传递，而接口文档就是记载各个不同业务用到的 api 接口以及它们所传递的信息的技术文档。但这类文档个别是外部用的，因此能够说是纯正为了开发办事，产品经理根本接触不到。
起初，跟着业务状态的开展，在某些业务畛域或技术畛域有较强劣势的公司会经过发售本身才能来获取销售的支出，好比领取才能、视频流媒体才能、AI 才能等，使得购买的公司可以以最快的形式完成相应的才能，而完成这类才能的形式之一，就是经过凋谢 api 接口来进行对接，接口文档能够让产品经理和开发工程师疾速对接业务和技术。
这么讲可能有点笼统，举个例子，好比我当初有一个商城产品，需求使用挪动领取，然而我本人没有金融牌照，不克不及做在线收款的业务，而某公司有金融牌照，能够开发在线领取的功用并进行在线收款，该公司经过凋谢相干的技术接口，商城只需求根据接口对接实现，由该公司来进行代收代付，便可实现在线收款的功用，固然，该公司在此过程当中可能会收取相应的费用，这类是属于有业务畛域劣势的类型。
此外一个例子，好比商城需求做一个在线直播的功用，然而目前公司没有在线视频流媒体等技术的专业开发人员和技术积攒，而某公司则是在这方面有着多年的教训和深挚的技术积攒，因此咱们能够购买接入该公司的办事，疾速完成在线直播的功用，这类，则是属于有技术畛域劣势的类型。
二、接口任务原理
下列图片能够帮忙咱们了解接口的任务原理：

3pyuiincas5.jpg

我举一个例子，好比【接口凋谢方】凋谢了一个接口，接口称号为【你好】，接口要求提供【姓名】作为参数，并前往【某某某，你好】的内容，其中【某某某】是申请接口时提供的【姓名】。
接口的交互用户是无奈感知的，所以需求在用户端处置内容的输出和输入，好比在网页上放一个输出框，让用户输出姓名，假定用户输出【李雷】，点击确认，这个时分，【接口申请方】申请【你好】这个接口，并传递姓名【李雷】，接上去就会收到【接口凋谢方】响应回来的信息【李雷，你好】，此时再将收到的这句话经过弹窗之类的方式在用户端显示出来，这样就实现了一次接口的调用。
【接口申请方】无需理会【接口凋谢方】外部的完成办法，只需关注收到响应后如何处置响应便可（如上方例子中的将收到的信息经过弹窗方式显示出来），而处置响应个别波及业务相干，所以需求产品经理染指，因此产品经理看文档的时分，需求知道，某个接口是为了完成甚么功用（好比上方的“你好”接口会前往问好的文字），需求提供甚么参数（如上方的“姓名”），会响应甚么参数（如上方的“某某某，你好”的信息），收到响应后要怎么处置（个别跟接入方的业务无关）。
三、惯例接入流程
这里讲的是惯例的接入流程，不代表一切平台都是以这样的形式接入，下列是接入流程示用意：

vjpe25pfafc.jpg

不是拿到接口文档就能接入，刚刚提到，接口提供方可能会根据某种形式来收取一定的费用，所以接口的使用确定是需求在接口凋谢方的受权下能力进行，所以在实现商务会谈之后，个别接口提供方会要求接入方在他们平台注册账号，并经过技术伎俩给接入放调配相干签名参数。
签名参数有两种作用：
所以签名参数能够了解为是带有身份信息的通行证，有了签名参数，能力够正常申请接口，而且每次申请，接口提供方都能知道是谁发动了接口申请。
四、怎么看接口文档
刚刚讲的都是一些纯实践的货色，接上去我以某电子发票平台的接口文档为例，讲讲假如我所在的平台需求减少一个开具电子发票的功用，在收到接口文档之后，要怎么看。

02nblskph13.jpg

这是接口文档的目录，在收到文档之后，倡议先看引见，这外面个别会波及到以后对接的这个产品的阐明、完成功用、合用场景等，产品经理需求结合本身产品的业务剖析要对接的产品的功用和合用场景是不是合乎公司想要完成的业务。
接上去是【调用形式】中的【签名办法】，这个需求分状况，假如你的平台是本人对接，本人使用，作为产品经理能够不必看这块，然而假如你做的 SaaS 零碎，你的平台可能会入驻多名商户，每名商户都需求去接口提供方平台注册并提供签名参数，你不成能每次有新入驻的商户就闪开发工程师往数据库里加数据，最公道的解决计划就是在后盾设计一个商户办理功用，在商户办理功用中减少签名参数的填写，这个时分，作为产品经理你就必需得知道，这个平台需求提供哪些签名参数，从而撑持你实现这块功用的设计，好比这个发票平台的签名参数要求提供下列4个参数：

xfpgmx31xkz.jpg

那末你在设计时，就需求提供相应参数的输出。
接上去是“主菜”，在 api 列表中，个别会根据不同的业务功用划分不同的接口，并以对应的业务形容来命名接口，因此，咱们假如要设计开具发票的功用，需求先找到对应的接口：

54dsru3zzgf.jpg

点击对应接口后，就能看到接口的详情，下列是作为产品经理需求关注的几个点：
口阐明：这外面个别会有一些对比首要的信息，一定要先子细浏览，有些产品经理一下去就跳过接口阐明的内容，间接看接口参数，而后遇到问题解决不了，始终在原地转圈，后果发现人家曾经在接口阐明中说了会遇到甚么问题，是甚么缘故，怎么解决。

drzdmj1twuh.jpg

申请参数：这个是产品经理需求重点关注的内容，这外面波及到在调用这个接口的时分需求提供甚么参数，这些参数往往都是用户输出的，因此产品经理需求按照所需参数在用户端采集相应的信息，如下列对于开具发票接口的部份申请参数：

htecqqw0u2p.jpg

这外面咱们要关注的，次要是【是不是必填】以及【形容】，形容中会阐明这个参数是甚么，有甚么要求，这里一定要区别好哪些参数是技术需求的，哪些参数是业务需求的，产品经理要重点关注业务参数，假如不分明参数的用处，能够找接口提供方的提供帮忙。
有一些相应的校验需求产品经理在用户端采集信息的时分就做好要求，避免提交给接口的参数是不合乎要求的，这样会挥霍网络资源（每次申请都需求等候回复，假如屡次尝试失败，会让用户感觉体验欠好），乃至挥霍金钱（有些平台会根据接口申请的次数免费，申请一次扣一次费用）。
响应参数：这是申请接口之后，接口提供方回传给咱们的参数，个别会包孕形态和对应的参数，如下是开具发票的响应参数：

i4irdx043ch.jpg

然而这里有点奇怪，咱们假如请求开具电子发票，最少要把电子发票的文件给咱们吧，否则咱们怎把文件给用户，这时候候咱们子细看一下，原来开票的接口是经过异步通知咱们的，这里就需求区别甚么同步甚么是异步了。
个别咱们提交之后，能够马上反馈给咱们的就是同步通知，好比这里的形态，告知咱们曾经提交胜利了或者曾经开过票了。而异步通知是说，咱们申请的这个接口需求的一部份内容，需求等候接口提供方处置，处置完之后再告知咱们后果，好比这里，开具发票请求提交胜利，然而开票平台需求同步税务局的零碎进行开票，这里需求有一个处置的时间，要等它处置完之后再告知咱们后果。
咱们能够找一下，发现接口文档中的确有一个【开票接口异步通知】的接口，点开发现这里前往的参数就十分多了，包罗开票的形态，电子发票开票胜利后电子发票的url等，收到相应的响应信息之后，咱们需求只需求处置对应的信息便可，好比前端可能需求更新开票的形态，或者显示电子发票的下载入口等。

gh3m2gjtbrv.jpg

以上是集体的教训之谈，但愿可以对刚入行的产品经理学习浏览接口文档有一定帮忙，感激浏览！
本文由 @产品锦李 原创公布于人人都是产品经理，未经许可，阻止转载。
题图来自Unsplash，基于CC0协定。
该文观念仅代表作者自己，人人都是产品经理平台仅提供信息存储空间办事。