概述

API套件用于为业务提供标准的对外接入协议,可以让多个软件/硬件厂商的第三方系统以统一协议标准进行接入(适配)。开发者的业务中,若需要支持外部系统的,并且由于针对不同客户、不同需求,可能支持的外部系统也会不同,所以可以使用API套件,规范业务中对外的部分,从而将这些规范好的协议,交由适配的厂商来完成。

API套件架构设计

API套件的基本流程

协议开发者

协议的开发者往往会是业务开发者。

1. 创建套件

通过开发者后台即可创建API套件,创建的API套件包含套件基本的功能信息、版本号、协议内容等

2. 定义协议

往往一个业务中会包含大量的与第三方系统对接的操作,而这些操作开发者可根据实际的业务抽象出标准的协议体。往往一个API套件中包含大量的协议,协议由基本的API请求结构组成,如url、请求类型、请求头、出参、入参、错误码等。

3. 上架套件

API套件及协议的过程并不需要实际的代码开发,只需制定规范即可。提交申请后,由平台方进行内容的审核。API套件支持更新多个协议的版本,但已上架的版本不允许被编辑,开发者只可以维护最新的未上架版本。不同版本之间数据隔离,确保租户的业务稳定。

适配器开发者

一个适配器往往对应一个厂商的某个型号的系统。适配器的开发者往往第一个适配器是由业务开发者开发,因为业务开发者才是第一个全面实现业务(业务、协议、适配器)本身的人或团队。而当业务全面完善后,第二个适配器可能是由业务销售过程中的二开人员,基于客户的实际需求进行开发。

1. 创建适配器

创建适配器必须先选择一个已上线的API套件,基于该套件进行创建。适配器由基本信息、配置参数、协议列表组成。
其中配置参数,往往是该适配器所属厂商定义的标准握手属性。开发者内置后,由租户采购厂商系统进行交付,租户在控制台安装该适配器时,需要录入配置参数的具体值。

2. 适配协议

适配器的协议列表,对应的是创建时选择的API套件下的协议,开发者需要对API套件下的所有协议进行逐个适配,才能支持API套件在使用过程中,完美覆盖业务的需求。
针对适配协议,中台提供一种在线脚本开发的能力,只需编写与第三方系统的认证、出入参转换、接口请求,即可完成适配工作。并且提供在线调试能力,可以验证适配是否成功。

3. 上架适配器

提交申请后,由平台方进行内容的审核后,租户即可安装该适配器。

业务开发者

1. API申请权限

业务必须先申请(接入)一种API套件,才可以在业务中访问协议的请求。同时租户在安装后,才可以根据申请的套件,安装相应的适配器。这其实是一种前置的预选过程。

2. 协议接入

开发者只需按照普通的接口调用方式,根据协议的url、请求方式、出入参,方可接入。

3. 上架

参照应用套件的上架过程。

租户

1. 安装业务

参照应用套件的安装过程。

2. 安装适配器

进入业务的协议配置功能,可以查看该业务已接入的API套件。租户可以根据自己实际需要对接的第三方系统,安装适配器、配置参数即可。同一个适配器可以安装多次,已支持业务的动态性。

3. 配置参数

参数的来源往往是第三方系统提供的IP、认证秘钥等一系列约定的参数。

4. 正常运作

安装及配置完成后,业务即可正常使用。当业务触发某个协议时,由中台识别出租户安装的适配器,并执行相应的适配器代码,访问到具体的第三方系统。

文档更新时间: 2022-06-14 17:14   作者:姚连洲