如何拆解接口文档
如何拆解接口文档
一、什么场景下会有接口文档
接口是银行与客户系统信息交互的方式,在分析评估系统对接相关需求时,接口文档是必不可少的技术桥梁。
在实际业务中,大型客户往往需要对接多家银行,因此会要求银行按照客户自定义的接口标准进行改造。
客户会将具体的对接规则写入接口文档,这时银行便需要主动改造系统适配客户的相关接口。谁提供接口文档,谁就掌握技术主动权。
二、接口对接前提:网络
银行网络通常通过防火墙、路由器等设备设置明确的网络边界,将内部网络与外部网络(如互联网、第三方网络)严格隔离。因此在与第三方机构合作时,需要先建立专门的接入通道。
方法一:专线对接
适用场景:监管机构、政府单位、大型合作机构等定制需求
优点:
缺点:
方法二:前置机方案
适用场景:企业银企直连
前置机是一台专门用来和银行系统对接的”中转站”。企业无法直接连接银行系统,企业通过先配置前置机,与银行进行数据交互。
举个例子,需要从 A 国(企业)去往 C 国(银行),但 C 国为了保护人民安全,严格审查出入境,因此几乎不对外开放,无法直飞,需要先飞到C 国相邻的 B 国,从 B 国去 C 国。
优点:相比专线对接,操作相对简易,成本可控缺点:依赖前置机和公共网络,稳定性无法保障
注意:现在部分银行开始提供免前置的方案,能提高对接效率
三、明确接口通讯方式
在接口文档中,”通讯协议”、”数据编码”、”数据格式”和”安全加密解密算法”是四个关键概念,需要重点关注。
一、通讯协议
定义:指客户端与服务端之间建立连接、传输数据所遵循的网络通信规则,决定了数据如何在网络中传输、如何建立/关闭连接、是否加密等。
常见类型:
|
|
|
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
二、数据编码
定义:指文本数据在传输或存储时转换为字节序列的方式,主要用于处理多语言字符(如中文、日文)。
作用:解决”字符如何变成字节”的问题,避免乱码。
常见类型:
|
|
|
|---|---|
|
|
|
|
|
|
|
|
|
三、数据格式
定义:指业务数据在传输时的结构化表示方式,即数据的”语法”或”组织形式”。
作用:解决”数据长什么样”的问题,便于双方解析。
常见类型:
|
|
|
|---|---|
|
|
|
|
|
|
四、安全加密解密算法
在数据传输过程中,为保证数据安全,会将传输的数据进行加密;数据使用方收到数据后需要先解密才能处理,因此双方需要提前约定加密解密算法。
加密方法对比:
|
|
|
|---|---|
| 对称加密 |
|
| 非对称加密 |
|
| 数字签名与证书 |
|
总结对比表
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
为什么需要了解这些:如果发现使用的是老旧接口技术,可能存在被淘汰的风险,需要及时进行技术升级和改造。
四、分析具体接口
接口分析的核心是分析对应业务场景与数据流转,但某些时候接口文档里的描述里存在一部门专业名词,比如:
夜雨聆风