接口对接流程梳理
产品经理
知晓自己负责系统做什么,外接三方系统做什么。
系统对接产品经理实操步骤:
①与公司业务人员沟通,与系统对接方产品/技术描述业务场景,沟通发放接口文档材料
②拿到材料之后电商API接口过多请对方圈定一下接口,在场景上如果少接口则继续和对方沟通确认
③看API接口,不太清楚哪些系统进行调用可以将材料发放研发团队一起查看沟通,比如哪些接口是前端商城研发调用,哪些接口是支付系统调用。
在输入值时如果涉及到要查别的系统数据,这个要在流程图中进行说明,如openid。
④看API接口,接口的输入输出,尤其针对枚举值,选输必输进行进一步确认。对于必输字段并不懂的输入的业务含义和对方确认,和自己的业务方确认,比如说appid(公众号Id),mchid(商户号)。
⑤绘制系统流程图与API接口清单,梳理功能点,绘制原型和写PRD文档
⑥PRD文档中增加与外对接API接口对接的输入输出逻辑说明。
⑦开发和测试环节对接过程中存在疑问继续跟踪。如果对方还在开发的接口项目管理同学要跟踪进度。
测试进行联测,对方测试人员要进行配合看数据。当然如果测试可以自己看到别人系统后台那要去看其他系统后台的数据。
⑧上线研发要换成生产环境的测试地址,和对方提前沟通上线时间和上线顺序,上线时是否要留相关人员on call
6.系统流程:接口文档对接梳理
详见积分商城需求文档示意(+v:hulianwangpm 获取资料)
7.产品需求文档中写接口需求
详见积分商城需求文档示意(+v:hulianwangpm 获取资料)
输入项:哪些字段决定了输出项。
输出项:页面展示和产品逻辑判断的时候我需要哪些字段。
8.接口梳理注意点总结
① 注意要测试环境和生产环境。生产上线时候要提醒研发换到生产环境调用。
② 注意必输字段和选输字段,要传入字段的含义和校验。枚举值不清楚含义的要询问对方含义,比如说单据类型字段枚举值是B2C发货单,BBC发货单,采购退货发货单等..
③ 注意唯一ID之间的关联,比如说我们订单系统的发货单号是001,到wms系统是否生成了一个新单号A001,那发货回执时候wms要给ODS系统001单号。
④ 注意基础信息的映射。比如说仓库代码和对方仓库代码是否一样,商品编码和对方商品编码是否一样。如果不一样还要进行映射,那映射的工作是谁来做。
⑤ 注意行信息和明细(我们常说的list)数据。哪些在行中,哪些在明细中,看的是单据和字段的关系,是一对一还是一对多,一对一就在行中,一对多就在明细中。比如说发货单只有一个发货仓,那么就是在行中,但是一个发货单有多个商品,那就在明细中。
行中部分数据和明细中的数据对的上,比如说发货单总金额=∑商品行总金额(商品单价*数量),发货单总实付金额=∑商品行实付金额(实付价*数量)。实付金额≠总金额,因为还存在促销活动使用优惠券等。那下游为什么要有这个字段呢?如果这个字段值我给的不精确会有什么影响呢?这都是要和下游沟通的,比如说下游发货保价,他是根据哪个价格保的,这样你就能判断哪些字段传的精确不精确的影响。
⑥ 接口文档字段的校验,比如说发货单下发Wms,wms会校验商品是否存在,仓库是否存在等,这些校验服务于业务需要,比如说商品都不存在,我怎么发货呢对吧,所以双方系统的基础数据要对齐。
⑦ 同步方式:增量和全量。这个一般在做基础数据同步的时候,比如说商品档案,会员信息等。增量指的是增加的变动的推送给其他系统,全量是定时比如每天推一下全部的数据。
9.接口文档常用名词整理
**同步和异步。**同步指的是同一时间处理,异步指的是不能实时处理,处理完结果再告知结果,会新增接口对接。
拉取和推送。 一般接口遵从谁是数据上游方,推送给下游。但是如果1个上游方对应N个下游方,这个时候上游机会提供拉取接口,下游都来拉数据。这样因为减少上游方开发工作量。上报
**联调。**跨系统对接时把接口调通。
**Mock。**有时候上下游没时间和开发联调,这个时候开发可以造数据自己先调。一般开发用postman工具mock接口。
调用地址/URL。生产环境测试环境
**API接口和MQ。**MQ【消息队列/消息中间件】可以用于内部系统对接非实时部分,具体看研发设计。