汽车商机系统,车厂经常需要开展各种各样的活动吸引客户到店试驾购车,获得的线索除了可以由运营人员手动批量上传到系统之外,因此我们系统还准备了一个通用接口,方便对接和汇总车厂开展各种渠道,自动导入线索。作为一名不写代码的业务员,如何组织程序猿哥哥完成接口开发?下面是本人根据之前的对接经历进行的总结。
场景:一方已有现成接口,外部业务来调用该接口传数。被调用方=A,调用方=B
1、对接沟通
A把现有的接口文档发给B,与B沟通清楚要对接的是哪些数据,包括但不限于以下内容:
(1) 参数(线索要传哪些值,注意大小写) 、传递类型 、哪些必传、 必传项是否有特定值、可接收名称还是只接收ID
(2)提供用于做映射的字段ID和code(通常这些ID不是限定值,如经销商id,线索来源id,后续有新增需要追补。注意:是否分测试ID和正式ID,别给错了增加沟通成本)
(3)B把双方的ID 、code 一一对应后,把表发回,这样双方都有同一份映射表,传数的时候就以这个表作为依据,把数据存到对应的数据表里。(例如B传过来code,A根据映射规则找到对应的ID,把该ID下的某个值做更新)
2、接口联调测试
(1)ip加入白名单:B提供请求接口的ip地址,A将其加入ip白名单;
(2)提供测试接口:A开通测试环境url、key、及必要的id值(专门指定的来源id),发给B。(一般会在写在接口文档上,key:public_key、private_key用于发送前加密,发送后解密);
(3)A接口配置:调用接口时需配置url、header名称、header值、resposen body等;
(4)一方在测试环境创造几条原数据、变更数据,一方做核对数值传输是否正常。如传数正确无误则表示接口已通;
(5)若测试异常:如遇到调用异常,传数不对,甚至接口不通的情况。B发送请求参数的日志,A做查询。一般原因包括但不限于:地址错误、传递的参数不对、未传必填参数、key大小写不分或不对,检查白名单缺失等等。
3、正式环境联调
(1)测试环境联调通过后,开放生产环境接口url、key、及必要的id值,发给对方调用。
(2)(3)跟测试环境的一致
4、接口跟踪维护
接口通了之后,但并非就可以高枕无忧了,还需日常的维护。如发现接口异常,需要撒黄芳配合操作及查找原因。例如:
(1)出现传的数丢失的情况,双方可以调取日志进行查询核对找出原因,可能的原因是临时通行中断,网络动荡,人为误操作,数据未传等。日志有专门的统计库,一种日志下面会有有很多个日志供查看。(一般这种情况下,双方都不希望是自己的问题,所以想打别人的脸之前,先检查自己这边是否没有问题,否则尴尬哈哈)
(2)执行补推机制,把丢失的数据再补推一遍。
域名或其他有变更,在新域名起效的前1~2个月,应邮件通知调取方切换为新的域名地址调用接口以获取数据。考虑到会调用方延迟更换,旧的域名应于新域名起效后延长使用一段时间,待对方把切换完毕后再关闭。
最后,希望对你有所帮助,大神轻喷~