iPaaS新功能上线：新增AK/SK插件和系统编码规范，还有五大优化！

好久不见，12月得帆云iPaaS又发布了诸多新功能特性，让我们一起来看看吧！

本次更新除了延续上期的拓展性升级外，还有代理透传、API文档等多重优化。哪个功能最好用？哪个功能最有用？快来一起GET新体验！

01

系统菜单新增「系统编码规范」

为增加API创建流程的便捷性，简化用户的操作步骤，支持在「规范管理-系统编码规范」菜单配置应用系统的API编码规范。「API编码规范」支持组合设置租户编码、应用系统编码和自定义文本3种规则，方便为不同应用系统定义API编码前缀。

「规范管理-系统编码规范创建弹窗」

设置完成后，创建API时，选择API所属应用系统，若该应用系统存在API编码规范配置，则根据配置项自动生成对应的默认API编码前缀。

注：API编码规范目前非强制规范，支持根据自动生成的内容进行修改；当前系统编码规范的3种规则下，同一应用系统的默认编码前缀相同，需要进行调整后才可保存。

「创建API-系统编码规范效果」

02

新增AK/SK鉴权插件

本次更新后，网关插件管理新增「AK/SK鉴权」插件，支持基于账号和密钥加密的方式进行身份认证。

「网关插件管理」

场景示例：

某公司业务系统希望在不改变原有业务系统授权认证方式并且不影响原有厂商调用的基础上在iPaaS平台接入一批含有AK/SK授权认证方式的接口，接入完成后希望通过iPaaS对该接口添加AK/SK鉴权，实现接口的统一管理。

1）消费者是iPaaS系统中对API存在消费行为的用户，系统支持为消费者添加账号（AK）和密钥（SK），用于调用时进行身份认证。

「AK/SK鉴权抽屉页-为消费者添加AK/SK鉴权信息」

2）调用时可依据加密需求传输具体参数，例如请求URI、API名称和版本、请求方式、消费者账号和密钥等。

「模拟客户端调用传参」

「未传输具体参数调用效果」

「传输具体参数调用效果」

03

门户支持多维度筛选API

得帆云iPaaS平台新增「API门户展示维度」功能，可设置门户页面展示API层级关系的颗粒度，方便用户快速定位目标API。

1）定义API层级关系：

「分类管理」新增“关联应用系统”字段信息，选择需要关联的应用系统，若为子分类，关联应用系统将自动填充父级分类关联的值。

「API开发」创建API时，选择当前API需要关联的分类，定义该API所属分类。

「分类管理-选择关联应用系统」

「创建API弹窗-选择API分类」

2）设置展示维度：

「租户信息-租户设置」中新增API门户展示维度设置，支持设置该租户门户页面是否展示分类，通过分类可清晰展示应用系统下API的层级关系。

「租户信息-API门户展示维度设置」

场景示例：

当企业接口量级较小且业务划分较为简单时，可选择不展示分类维度（对应下图一）；当企业接口量级大且业务层级划分较为复杂时，可通过后台维护接口分类层级，并选择展示分类维度，企业内部消费者则可通过层级筛选快速在门户定位到API（对应下图二）。

「API门户-API展示-不展示分类」

「API门户-API展示-展示分类」

04

新增支持HTTPS双向认证

本次更新后，系统HTTP连接器新增HTTPS接口信任证书配置，支持调用下游HTTPS接口时，通过接口单向/双向认证。

场景示例：

某公司存在HTTPS的接口，接口需通过双向认证才能访问调用，公司希望通过iPaaS平台实现接口调用，获取接口返回后按业务要求进行数据处理。

在API编排通过HTTP连接器调用该HTTPS接口，配置访问HTTPS协议所需信任证书，依此通过双向认证，获取接口响应后，在编排继续添加数据转换等组件实现数据处理即可。此外，在配置证书时，系统提供“测试证书”功能，支持校验证书合法性。

「HTTP连接器-添加API地址：选择HTTPS类型」

「系统内调用双向认证接口效果」

05

代理透传两大优化

1）支持代理原接口认证：

添加代理地址时，支持维护代理接口的Basic Auth或OAuth 2.0授权认证信息，通过iPaaS平台统一提供接口认证。

场景示例：

企业中存在一批具备OAuth 2.0认证的接口，希望接入iPaaS系统，通过系统统一提供认证信息，并记录下接口运行和消费者调用情况。

代理接口时，接入原接口授权认证信息：

「代理透传-基本定义-添加代理地址」

调用接口时，无需提供授权认证信息，可直接调用（调用效果如下）。调试成功后，即可通过平台内置授权认证插件为接口添加认证，统一管理接口的调用情况。

「调试页面-直接调用效果」

2）新增批量代理透传功能：

若企业各应用系统下存在大量已有的接口，可通过Excel模版整理后快速维护进iPaaS平台。批量代理透传入口位于原「API开发-代理透传」创建弹窗下方。

「API开发-创建代理透传」

导入过程需完成下述三步骤：

「下载模板」：支持下载Excel模板，按照模板将已有接口信息和相关数据整理到Excel表格中，注意不要修改表头。单次导入数据上限为5000条，超出部分无法导入。

「配置基础信息」：需要选择API导入的目标应用系统。支持选择当前用户角色下具有数据权限的应用系统。

「上传文件」：可将维护好的Excel文件拖拽至此区域，或者点击选择文件。

「批量代理透传」

上传文件后可在进度条下方查看导入结果，点击查看详情新开浏览器tab页显示导入结果表格。若存在导入失败数据时，支持将文件中的失败数据整合成新的Excel文件下载，用户可再次调整模板中的数据后上传。导入成功的数据支持直接在API开发页面发布使用。

「批量代理透传导入结果」

06

API文档三大优化

1）新增授权认证方式模块：

支持查看API的授权认证方式及使用方法。

场景示例：

若需要将平台内的API提供给第三方供应商调用，且供应商无法访问平台，只能通过API文档（PDF）的方式提供请求地址等调用信息，此时可通过API文档直接告知供应商调用该API需要满足的授权条件。

用户可在API开发页面点击API文档进入在线API文档页面，导出PDF提供给供应商，供应商可在文档最后面的授权认证方式模块，查看当前API应用系统或路由上的授权认证插件类型及使用方法。

「在线API文档」

「API导出的PDF文档」

此外，也支持在运行列表点击下载接口文档导出PDF文档提供给供应商。

「运行列表」

2）优化请求/响应示例的默认值来源：

支持在接口开发时通过手动维护或自动生成方式获取Body参数示例值或说明，接口发布后，将自动带入API文档中，减少文档维护时间成本。

API编排：支持在HTTP请求和HTTP响应节点维护Body参数的示例值和说明。

「API编排-HTTP请求」

代理透传：支持在「API基本定义-接口示例」维护请求、响应Body参数的示例值和说明。

「代理透传API基本定义-接口示例」

维护完成后，初次发布API，API文档会自动同步请求/响应节点或者接口示例中维护的参数信息。

快速开发：支持在创建弹窗/基本定义或发布时，根据所选关键配置项自动生成请求/响应示例及参数说明。本次优化范围包括「基于RFC快速开发」、「RFC快速转换WebService」、「基于数据库快速开发」和「数据库快速转换WebService」4种快速开发类型。

• RFC快速开发：支持在创建弹窗和基本定义页面，根据所选RFC函数自动生成输入/输出参数结构示例及参数说明，其中RFC函数字段参数说明来源于SAP原生定义。包括「基于RFC快速开发」和「RFC快速转换WebService」2种类型。

「RFC快速转换WebService」

初次发布后，将根据基本定义页面的数据自动生成API文档内容。

「RFC快速转换WebService的在线API文档」

• 数据库快速转换WebService：支持在创建弹窗/基本定义页面，根据所选操作类型及操作类型关联字段，自动生成输入/输出参数的结构示例和参数说明，其中表字段参数说明来源于数据库原生定义。

「数据库快速转换WebService的创建弹窗」

「数据库快速转换WebService的基本定义页面」

初次发布后，将根据基本定义页面的数据自动生成API文档内容。

「数据库快速转换WebService的在线API文档」

• 基于数据库快速开发：初次发布时，将根据所选操作类型及操作类型关联字段，自动生成API文档的输入/输出参数的结构示例和参数说明。

「数据库快速开发的API文档」

3）API文档新增Body格式类型：

支持维护JSON、XML、x-www-form-urlencoded、form-data等8种格式的请求、响应Body。

07

IP控制插件：

支持自定义IP来源Headers

如当前网关处获取的IP地址与实际需要控制访问的IP不符，支持自定义设置IP所在的Header位置。设置完成后租户内所有请求将根据IP来源Headers规则获取IP地址，从而进行黑/白名单匹配。

场景示例：

某公司网络架构较为复杂，请求至网关处的IP地址记录不稳定，但存在一个重要API公司希望严格控制客户端原始IP为指定IP时才能进行访问。

经过对公司网络架构的分析，确定当前环境下客户端原始IP主要记录在Original_IP或Client_IP2个Header中。对此，可在「IP控制设置」弹窗，选择「IP来源」为自定义，并配置「IP来源Headers」为Original_IP和Client_IP。

• IP来源：除了自定义还可以选择系统默认，系统默认指根据网关处直接获取的IP地址进行匹配。
• IP来源Headers：根据Headers的值进行IP黑/白名单匹配；输入多个Headers时，顺序表示匹配优先级，若未找到第一个Header或第一个Header值为空，则继续匹配第二个Header的内容；若请求中所有Headers的值都无法获取，则直接禁止访问。

「网关插件管理-IP控制设置」

完成以上设置后，当Headers中Original_IP或Client_IP的值与插件配置的白名单中的IP地址匹配时，则可成功访问当前租户内的API。

「Client_IP为指定IP，成功访问」

「Original_IP不是指定IP，访问失败」

本次更新就分享到这里了。以上都是研发团队深挖用户实际业务场景后进行的更新优化，希望能全面提升得帆云iPaaS的易用性和灵活度，完善您的使用体验！

对于本次更新，如果您有哪些功能需要进一步视频讲解，或者您有更好的更新建议，欢迎联系我们反馈！