关于和第三方接口联调的一点经验随笔

在系统开发过程中,我们经常会涉及到和第三方服务联调的过程。关于和第三方进行接口联调,稍微说下自己的想法。

1. 接口文档

接口文档是我们了解第三方接口的基础。通过接口文档我们能大致了解每个接口的功能,调用的场景是什么,调用时需要传哪些字段,调用过程中是否需要进行加解密等。所以在和第三方进行开发联调前,你一定要问第三方要一份详细的接口文档。

2. 梳理接口文档

拿到接口文档后,你需要仔细阅读接口文档,下面的这些问题需要你重点关注。

  • 第三方提供的接口是否能满足你们自己的业务需求?假如提供的接口不能满足你的业务需求,你需要让对方补充接口,如果对方不能补充的,你就要考虑下其他方案,同时想下还有没有和第三方继续对接的需要;
  • 理清楚第三方提供的每个接口的功能,弄清楚这些接口在你们的业务场景中的调用时机是什么,最好能画出一个流程图或者时序图,这样会更加清楚;
  • 确认下接口请求是否需要加解密操作,如果需要最好是让对方提供一个加解密的demo,这样会减少出错的可能性,加快联调速速;
  • 确认对接过程中是否需要第三方为我们分配渠道号、产品代码、加解密秘钥等这些固定参数,如果需要的话,提前向第三方申请,这样也会加快开发进度;这些参数包括开发、测试和生产的,一般情况下生产的参数在联调阶段都给不出来,你可以记一个todo-list,以免上线时忘记;
  • 确认第三方的接口调用地址,你们的系统是否能够调得通,如果不通的话,你可能要提前通知你们的运维人员开通网络防火墙(包括测试和生产)
  • 梳理接口的入参和返参,你要明确每个字段的含义是什么,怎么传,你们系统是否能提供这个字段,返回参数哪些是你需要的,等等。

梳理接口阶段你必须做完上面这些工作才算合格。不要觉得这些事情不重要,这些梳理工作能让你提前发现很多问题。而等到开发联调时才发现,可能会让你的“手足无措”。

3. 开发联调

虽然有接口文档,但是由于种种问题,接口的实际运行和我们理解的总是有出入的。开发联调阶段就是验证接口是否满足接口文档的描述。如果你的接口文档梳理的很到位的话,开发联调阶段应该是非常轻松的。

这边有个小建议:就是在调用第三方接口时,对于第三方系统抛出的异常不要处理,直接向上抛出,让你们系统的业务代码处理。

4. 上线阶段

当开发联调完成后,就是要系统上线了。上线前我们应该要确认好下面的事情:

  • 三方系统是否能支持我们的上线排期;
  • 我们的系统和三方系统网络是否已经开通;
  • 渠道号、产品代码、秘钥这些参数生产环境是否配置正确;

确认完这些事情后上线一般就没什么大问题了。