接入第三方系统接口场景-通用API

1.      场景描述

存在多个业务系统，如系统A、B、C ……，各个业务系统间存在接口调用情况，这时首先需要打通各个系统之间的网络连接，其次一个系统调用其他业务系统时，需要和各个系统进行认证，错综复杂，这时就需要一个公共的平台将所有系统的业务接口统一管理，对外提供统一的出口，每个业务系统只需要和接口管理平台来统一认证对接即可，简化服务间的对接工作。

2.      场景分析

服务集成可以通过通用API接入第三方业务系统的接口，实现接口的注册、代理和转发。

3.      示例前置条件

第三方接口对应的接口文档，如果是带动态认证的第三方接口，需要提前添加认证模板。[服务集成/API工厂/认证模板]页面，单击<新增>按钮，添加认证模板。

图-1 配置认证模板

 

4.      示例详细步骤

  1. [服务集成/API工厂/API管理]页面，单击<API注册>按钮，选择注册类型为“通用API”，进入通用API设计页面，配置通用API基本属性。

图-2 配置基本属性

 

  1. 配置完基本属性后，单击<下一步>按钮，配置接口的调用信息。配置接口的请求路径，接入类型选择外部API，配置第三方接口类型及地址，配置请求方式，如果接口带认证，则认证模板关联提前添加好的模板，配置请求头信息、输入输出参数信息，单击<下一步>。

图-3 配置调用信息

 

  1. 单击<下一步>，查看配置的通用API的整体信息。

图-4 API预览

 

  1. 单击<保存>按钮，返回API管理页面。在AP管理页面可以看到新增的API。单击<测试>按钮，可进行接口测试。

图-5 API测试

 

  1. 接下来的部署、授权操作，可参考将数据库字段共享开放成接口场景-数据API中数据API“示例详细步骤”中的第9步。