新手产品经理必学技术接口文档知识
产品经理需不需要懂技术接口文档?这个问题我觉得就跟问产品经理需不需要懂技术是一样的,而我的建议是,需要懂,但只需要有限度地懂。今天我结合之前的一些项目经验,以对接电子发票中的开具发票接口为例,分享产品经理怎么学会看懂技术接口文档。
本文是以产品经理理解的角度去说明和解构接口文档,可能在技术角度未必是正确的,如果有卧底的开发大佬,还请勿喷!
一、什么是接口文档
要学会看接口文档,首先得明白什么是接口文档,接口文档的作用是什么。
随着开发技术的发展,渐渐发展成为前后端分离的开发方式,简单讲就是前端开发工程师和后端开发工程师各自开发属于自己范围的内容,最后通过api 接口来进行前后端信息的传递,而接口文档就是记录各个不同业务用到的api 接口以及它们所传递的信息的技术文档。但这种文档一般是内部用的,因此可以说是纯粹为了开发服务,产品经理基本接触不到。
后来,随着业务形态的发展,在某些业务领域或技术领域有较强优势的公司会通过出售自身能力来获得销售的收入,比如支付能力、视频流媒体能力、AI 能力等,使得购买的公司能够以最快的方式实现相应的能
力,而实现这种能力的方式之一,就是通过开放api 接口来进行对接,接口文档可以让产品经理和开发工程师快速对接业务和技术。
这么讲可能有点抽象,举个例子,比如我现在有一个商城产品,需要使用移动支付,但是我自己没有金融牌照,不能做在线收款的业务,而某公司有金融牌照,可以开发在线支付的功能并进行在线收款,该公司通过开放相关的技术接口,商城只需要按照接口对接完成,由该公司来进行代收代付,即可完成在线收款的功能,当然,该公司在此过程中可能会收取相应的费用,这种是属于有业务领域优势的类型。
另外一个例子,比如商城需要做一个在线直播的功能,但是目前公司没有在线视频流媒体等技术的专业开发人员和技术积累,而某公司则是在这方面有着多年的经验和深厚的技术积累,因此我们可以购买接入该公司的服务,快速实现在线直播的功能,这种,则是属于有技术领域优势的类型。
二、接口工作原理
以下图片可以帮助我们理解接口的工作原理:
我举一个例子,比如【接口开放方】开放了一个接口,接口名称为【你好】,接口要求提供【姓名】作为参数,并返回【某某某,你好】的内容,其中【某某某】是请求接口时提供的【姓名】。
接口的交互用户是无法感知的,所以需要在用户端处理内容的输入和输出,比如在网页上放一个输入框,让用户输入姓名,假设用户输入【李雷】,点击确认,这个时候,【接口请求方】请求【你好】这个接口,并传递姓名【李雷】,接下来就会收到【接口开放方】响应回来的信息【李雷,你好】,此时再将收到的这句话通过弹窗之类的形式在用户端显示出来,这样就完成了一次接口的调用。
后端工程师需要掌握哪些知识【接口请求方】无需理会【接口开放方】内部的实现方法,只需关注收到响应后如何处理响应即可(如上方例子中的将收到的信息通过弹窗形式显示出来),而处理响应一般涉及业务相关,所以需要产品经理介入,因此产品经理看文档的时候,需要知道,某个接口是为了实现什么功能(比如上方的“你好”接口会返回问好的文字),需要提供什么参数(如上方的“姓名”),会响应什么参数(如上方的“某某某,你好”的信息),收到响应后要怎么处理(一般跟接入方的业务有关)。
三、常规接入流程
这里讲的是常规的接入流程,不代表所有平台都是以这样的方式接入,以下是接入流程示意图:

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。