目  录

1 产品简介

1.1 产品介绍

1.2 功能使用介绍

1.3 应用场景

2 服务集成开放API

2.1 开放API

2.1.1 创建工作空间

2.1.2 新建数据源（可选）

2.1.3 API注册

2.1.4 API测试

2.1.5 API部署

2.1.6 API授权

2.1.7 API的使用

2.2 服务编排

3 服务集成开放文件资源

4 资产上线到资产市场

5 API管理

5.1 认证模板

5.2 环境配置

5.3 规则管理

5.4 熔断管理

1 产品简介

1.1  产品介绍

服务集成是H3C 绿洲融合集成平台的服务集成组件，支持将已有后端服务、数据源和自定义函数封装成标准的RESTful API并对外开放，并且支持文件资源的开放。

·     支持便捷的API生命周期管理

服务集成提供了API的全生命周期管理，从API的创建（数据API、通用API及函数API）、调试、发布、下线、授权、编辑和删除等，实现完整的API解决方案。

·     支持可视化的API监控面板

服务集成提供了可视化的API调用分析看板，帮助您监控API调用的性能指标信息，识别可能影响业务的潜在风险。

·     支持多层安全防护措施

服务集成提供了多种认证鉴权方式、精细化的流量控制、严格的访问控制等安全防护措施，全方位保护API安全调用。

图1-1 服务集成架构

1.2  功能使用介绍

在融合集成平台中，服务集成提供了开放API及文件的功能，并可对API进行服务编排。开放的API及文件还可上线到资产市场，提供给其他组织进行使用。

图1-2 功能使用介绍

1. 服务集成开放API

(1)     服务集成支持开放数据API、通用API及函数API，封装成标准的RESTful API对外开放。具体配置流程参见2.1  开放API。

(2)     API开放之后，如果单个API不能满足用户需求，服务编排可以通过画布的方式，在页面利用拖拉拽来实现多个API的流程编排、参数解析、流程控制、结果组合及结果选择。多个API进行服务编排后会生成一个新的API，用户可将新的API对外开放。具体配置流程参见2.2  服务编排。

2. 服务集成开放文件

用户可通过文件管理功能实现文件资源在组织内的共享，具体配置流程参见3 服务集成开放文件资源。

3. 资产上线

融合集成平台系统内存在多个组织，组织A开放的资产（API资产、文件资产）通过主动授权只能授权给组织A内的工作空间使用，组织B如果想要使用组织A发布的资产，需要组织A将资产上线到资产市场，通过认证、审批将资产统一开放给其他组织进行使用。具体配置流程参见4 资产上线到资产市场。

1.3  应用场景

服务集成通过其丰富的集成能力，将各系统的能力进行集成、组合、封装，最终形成各类资产，为上层业务联动和业务创新提供支撑。

·     业务系统通过API接口的方式接入绿洲平台，经过接口适配、接口管理和接口编排后推送至资产市场。

·     物联平台通过融合集成平台消息集成将事件消息接入绿洲平台，经过协议适配、消息解析后通过函数API封装后推送至资产市场。

·     资产市场通过申请审批机制，实现数据资产的共享。

2 服务集成开放API

2.1  开放API

服务集成支持开放数据API、通用API及函数API。

·     数据API通过向导式的设计将数据库表里字段开放出去，以标准RESTful接口的形式对外提供。支持的数据源类型目前包含MySQL、PostgreSQL、Presto、Oracle、SQL Server、达梦、Vertica、Impala，DB2、SeaSQL MPP、UXDB等。

·     通用API设计用来对已经存在的第三方接口进行代理。

·     函数API可以在系统内通过编写JavaScript脚本，设计并生成标准RESTful接口。

用户可以在服务集成模块中创建API然后供组织内的用户进行使用，整体配置流程如图2-1。

图2-1 开放API配置流程图

表2-1 开放API配置流程说明

2.1.1  创建工作空间

工作空间是为了让用户更好的将项目相关资源进行统一管理。比如用户可以新建工作空间，然后将同一项目的相关资源创建在一个工作空间下，方便后续查看及操作。当用户登录系统后，如果系统中没有工作空间，页面会提示用户创建工作空间；如果同组织下的用户已创建了工作空间，也可以直接使用。

(1)     在工程配置模块下，选择左侧导航树中的[工作空间]，进入工作空间页面。

(2)     工作空间页面单击<新增>按钮，弹出新增工作空间页面，用户可根据实际进行新增。

图2-2 新增工作空间

(3)     根据实际需要配置对应参数项的值，参数说明如下：

¡     工作空间ID：必填，根据实际需要配置工作空间ID。工作空间ID用于工作空间下API使用时的认证ID。

¡     工作空间名：必填，根据实际使用需要配置工作空间名称。

¡     认证类型：必选，支持私钥认证。根据认证类型生成工作空间下API使用时的认证秘钥。

¡     描述：非必填，工作空间相关的描述信息。

(4)     配置完成后，单击<确定>按钮完成工作空间的新建。

2.1.2  新建数据源（可选）

服务集成数据API支持将数据库表里字段开放出去，以标准RESTful接口的形式对外提供。用户如果创建数据API，需要提前将相关数据源添加到融合集成平台。

(1)     [数据源管理]页面单击<新增>按钮，弹出新增数据源窗口。

图2-3 新增数据源

(2)     根据实际情况，选择需要的数据源类型进行配置，配置完相关参数后，单击<提交>按钮，完成数据源新增。

2.1.3  API注册

API注册用于将API注册到系统中，只有注册到系统中才能进行后续的部署、授权、上线等操作。

API注册具体步骤如下：

(1)     在[融合集成/服务集成/API工厂/API管理]页面单击<API注册>按钮进行API的注册，用户可根据实际需要选择需要的API类型进行注册。

图-1 API类型选择

(2)     选择API注册类型后，进入API设计页面，用户需根据实际情况配置API相关信息。

¡     数据API注册

¡     通用API注册

¡     函数API注册

1. 数据API注册

如果注册的API类型选择“数据API”，进入数据API配置页面。

(1)     配置基本属性：

¡     API名称：配置API名称，系统会自动对API名称进行重复校验，不允许同一工作空间内存在两个相同的API名称。

¡     标签：为API配置标签，用户可在输入框中选择系统内已存在的标签，或者直接单击<新增>按钮，新增一个标签，支持一次为API配置多个标签（最多5个）。

¡     描述信息：API的描述信息。

¡     所属目录：选择API所属的目录，API创建完成后将展示在对应目录下。

¡     图标：配置API的图标。可选择系统默认图片或者本地上传图片。

¡     版本号：系统做了API版本管理的功能，所以API的版本号不允许重复。

¡     版本描述：当前版本的描述信息。

图2-4 配置API基本信息

(2)     配置完成API基本信息后，单击<下一步>进入API调用信息配置页面，用户根据实际情况配置调用信息。

¡     请求路径：以“/”开头的自定义访问路径，且只能包含字母、数字、“-”、“_”“.”、“/”，如“/api/v1.0/api-test”。

¡     开启认证：默认是开启认证的，开启认证后，用户在授权时需选择静态认证或动态认证；如果不开启认证，则在授权时无需选择认证方式，用户在实际使用该API时也无需进行认证。

¡     开启健康检查：配置是否开启健康检查，开启后，系统后台会定时检查API健康情况，同时会在API列表中展示API最新状态（正常、异常）；如果API状态异常，系统还会发送告警信息。如果未开启健康检查，API列表中的健康状态会展示为“未知”。

¡     请求参数格式：默认都是json格式。

¡     返回参数格式：默认都是json格式。

¡     数据源：选择需要开放数据的数据源，用户需提前准备数据源，关于新建数据源的具体操作可参见2.1.2  新建数据源（可选）。支持的数据源类型目前包含MySQL、PostgreSQL、Presto、Oracle、SQL Server、达梦、Vertica、Impala，DB2、SeaSQL MPP、UXDB等。

¡     数据库：选择要发布的数据库。

¡     数据模式：选择要发布的数据库里面的模式。

¡     数据表：选择要发布的数据库里面的表。

¡     关联条件：关联条件的配置用于多表关联查询，可以将两张表的字段做关联，这里支持的关联方式包括LEFT JOIN、INNER JOIN以及RIGHT JOIN等。如果只需要查询一张表的字段信息，则不需要配置关联条件。

¡     选择操作模式：数据API支持自定义SQL语句和字段筛选两种方式发布，自定义SQL语句可以实现复杂的SQL查询，字段筛选方式是以开放字段的方式发布，API授权和订阅时可以勾选需要订阅的字段。当选择自定义SQL语句时，支持在线SQL执行、SQL格式化以及SQL选中执行（执行光标选中的部分）。

¡     SQL语句：选择自定义SQL方式发布后，可以选择字段，在选择字段的时候，可以看到字段名、所属表、类型以及字段描述，这里可以选择过滤列来作为筛选条件，支持AND和OR。选择完字段后会自动生成一条SQL语句，目前只支持select查询方式。生成的SQL语句支持编辑，可以编写复杂的SQL语句进行查询，SQL语句中输入参数解析规则以英文冒号开头，例如“select id, name from table where id =:id”。

¡     输入/输出参数：SQL语句编写完成后，单击<生成参数>，可以生成输入输出参数。如果SQL语句中设置的是非必填参数，在输入参数列表中，需要将该参数设置为非必填。根据输入参数的字段类型来选择数据类型，目前支持的字段类型包括string、integer、long、float、double、bit、numeric、boolean、date、time、timestamp等，输出参数的类型按string来处理。

¡     字段列表：如果数据API发布方式选择字段筛选，则需要选择开放的字段，单击<选择字段>，可以看到字段名、所属表、类型以及字段描述，勾选需要开放出去的字段，单击<确定>按钮。在字段列表可以查看开放出去的字段，包括字段名称、所属表、字段别名、数据类型、字段描述，输入参数按钮和输出参数按钮可以控制该字段是否要作为输入或者输出参数，一个字段可以同时打开输入参数和输出参数按钮。字段别名和字段描述可以根据实际情况进行编辑。

¡     筛选条件：数据API发布方式可以选择字段筛选，在选择完需要开放的字段后，可以设置筛选条件，该条件为非必填项，筛选条件格式要求以where开头，例如“where id > 3”，在接口查询时，会加上默认的筛选条件，只查询id > 3的数据。单击<下一步>可以进行基本属性和参数配置的预览。

图2-5 API调用信息配置

(3)     配置完成调用信息后，单击<下一步>按钮，进入API预览页面。在预览页面，用户可以查看已填写API的基本信息、参数配置信息以及数据来源，如果没有问题就可以单击<保存>，这样就可以完成数据API的注册。

图2-6 API预览

(4)     保存后的API在API列表中的状态为“待测试”。

图2-7 API列表

2. 通用API注册

如果注册的API类型选择“通用API”，进入通用API配置页面。

(1)     配置基本属性：

¡     API名称：配置API名称，系统会自动对API名称进行重复校验，不允许同一工作空间内存在两个相同的API名称。

¡     标签：为API配置标签，用户可在输入框中选择系统内已存在的标签，或者直接单击<新增>按钮，新增一个标签，支持一次为API配置多个标签（最多5个）。

¡     描述信息：API的描述信息。

¡     所属目录：选择API所属的目录，API创建完成后将展示在对应目录下。

¡     图标：配置API的图标。可选择系统默认图片或者本地上传图片。

¡     版本号：系统做了API版本管理的功能，所以API的版本号不允许重复。

¡     版本描述：当前版本的描述信息。

图2-8 配置API基本信息

(2)     配置完成API基本信息后，单击<下一步>进入API调用信息配置页面，用户根据实际情况配置调用信息。

¡     请求路径：以“/”开头的自定义访问路径，且只能包含字母、数字、“-”、“_”“.”、“/”，如“/api/v1.0/api-test”，可选精确匹配和模糊匹配两种方式。

-     精确匹配：用户访问该API请求时的路径要与此处配置的请求路径完全一致才能访问。

-     模糊匹配：API请求中的全路径透传到后端服务。

¡     开启认证：默认是开启认证的，开启认证后，用户在授权时需选择静态认证或动态认证；如果不开启认证，则在授权时无需选择认证方式，用户在实际使用该API时也无需进行认证。

¡     开启健康检查：配置是否开启健康检查，开启后，系统后台会定时检查API健康情况，同时会在API列表中展示API最新状态（正常、异常）；如果API状态异常，系统还会发送告警信息。如果未开启健康检查，API列表中的健康状态会展示为“未知”。

¡     接入类型：外部API和内部API，外部API主要是指第三方系统的接口，内部API目前主要是通过函数API生成的接口。

¡     第三方接口类型：Rest或者WebService。

¡     wsdl接口地址：当第三方接口类型选择WebService时，需要填写该项。

¡     WebService方法：系统会自动解析wsdl，用户需从下拉列表中选择需要代理的方法进行代理。

¡     第三方接口地址：接入外部API时填写完整的第三方接口地址，格式如：http(s)://域名/url 或 http(s)://ip:port/url；当第三方接口类型是WebService时，会自动填充该项；接入内部API时选择相应的函数API。

¡     请求方式：选择接口的请求方式，外部API可以选择GET/POST/PUT/DELETE，内部API目前只支持POST和GET。

¡     认证模板：接入第三方接口时，如果该接口带动态认证，则需要在[API工厂/认证模板]中添加认证模板，然后在此处选择认证模板，如果该接口不带认证，则不需要选择认证模板。关于认证模板的详细介绍可参见5.1  认证模板。

¡     请求参数格式：请求参数的格式。当请求方式为get时，只能选择JSON格式；当为其他方式时，可选JSON格式，XML格式、Text格式、form-data格式或x-www-form-urlencoded格式。

¡     返回参数格式：返回参数的格式，可以选择JSON格式，或者XML格式。

¡     请求头配置：填写接口的请求头信息。

¡     入参配置：入参列表，配置入参的字段名和数据类型等信息，需根据第三方API入参进行填写；如果是xml类型的入参，则可以在入参示例（第三方接口类型为Websevice时会出现该配置页签）中填写。

¡     出参配置：配置出参的字段名和数据类型等信息，需根据第三方API出参进行填写。当API是外部API且第三方接口类型为Rest时，页面会显示<获取出参>按钮，用户可单击该按钮，自动获取出参。

¡     错误码：填写接口请求出错时的错误码信息。

图2-9 API调用信息配置

(3)     配置完成调用信息后，单击<下一步>按钮，进入API预览页面。在预览页面，用户可以查看已填写API的基本信息、调用信息等，如果没有问题就可以单击<保存>，这样就可以完成通用API的注册。

图2-10 API预览

(4)     保存后的API在API列表中的状态为“待测试”

图2-11 API列表

3. 函数API注册

如果注册的API类型选择“函数API”，进入函数API配置页面。

(1)     配置基本属性：

¡     API名称：配置API名称，系统会自动对API名称进行重复校验，不允许同一工作空间内存在两个相同的API名称。

¡     标签：为API配置标签，用户可在输入框中选择系统内已存在的标签，或者直接单击<新增>按钮，新增一个标签，支持一次为API配置多个标签（最多5个）。

¡     描述信息：API的描述信息。

¡     所属目录：选择API所属的目录，API创建完成后将展示在对应目录下。

¡     图标：配置API的图标。可选择系统默认图片或者本地上传图片。

¡     版本号：系统做了API版本管理的功能，所以API的版本号不允许重复。

¡     版本描述：当前版本的描述信息。

图2-12 配置API基本信息

(2)     配置完成API基本信息后，单击<下一步>进入API调用信息配置页面，用户根据实际情况配置调用信息。

¡     请求路径：以“/”开头的自定义访问路径，且只能包含字母、数字、“-”、“_”“.”、“/”，如“/api/v1.0/api-test”。

¡     开启认证：默认是开启认证的，开启认证后，用户在授权时需选择静态认证或动态认证；如果不开启认证，则在授权时无需选择认证方式，用户在实际使用该API时也无需进行认证。

¡     开启健康检查：配置是否开启健康检查，开启后，系统后台会定时检查API健康情况，同时会在API列表中展示API最新状态（正常、异常）；如果API状态异常，系统还会发送告警信息。如果未开启健康检查，API列表中的健康状态会展示为“未知”。

¡     接口类型：用户可选择该接口类型为Rest或WebService。

¡     请求方式：选择接口的请求方式，目前只支持POST和GET。

¡     请求参数格式：请求参数的格式，目前是JSON格式，不可修改。

¡     返回参数格式：返回参数的格式，目前是JSON格式，不可修改。

¡     请求头配置：填写接口的请求头信息。接口类型为Rest时，若需要配置的参数较多，可在“请求头示例”中输入JSON对象，单击“请求头列表”可自动解析输入的参数。

¡     入参配置：配置入参的字段名和数据类型等信息，需根据所设计的API入参进行填写。接口类型为Rest时，若需要配置的参数较多，可在“入参示例”中输入JSON对象，单击“入参列表”可自动解析输入的参数。

¡     出参配置：配置出参的字段名和数据类型等信息，需根据所设计的API返回值进行填写。接口类型为Rest时，若需要配置的参数较多，可在“出参示例”中输入JSON对象，单击“出参列表”可自动解析输入的参数。

¡     错误码：填写接口请求出错时的错误码信息。

图2-13 API调用信息配置

(3)     配置完成调用信息后，单击<下一步>按钮，进入服务脚本配置页面。

¡     服务脚本：API接口的内部执行逻辑，目前支持JavaScript脚本。在编写完成JavaScript脚本之后，可以单击<测试脚本>，校验服务脚本的正确性。

¡     可配置封装返回结果，是否对JS的返回结果进行封装。不勾选时，直接返回服务脚本的执行结果；勾选后将返回结果放到result里，返回结果在服务脚本中由用户自己定义。

¡     编写脚本的过程中可以配置环境变量和获取系统密码箱中的密码。环境变量和密码箱的配置请参见密码箱管理和环境变量。

图2-14 服务脚本配置

(4)     配置完成调用信息后，单击<下一步>按钮，进入API预览页面。在预览页面，用户可以查看已填写API的基本信息、参数配置以及服务脚本，确认配置正确后单击<保存>，即可完成函数API的注册。

图2-15 API预览

(5)     保存后的API在API列表中的状态为“待测试”

图2-16 API列表

2.1.4  API测试

API注册完成后，需通过API测试功能来测试注册完成后的API是否正确，只有通过测试的API才能进行部署。

(1)     在[服务集成/API工厂/API管理]页面单击<测试>按钮进入API测试页面。

(2)     在测试页面可以查看API的基础信息，包括API名称、请求方式、请求路径、请求头配置和请求参数配置等信息。填写接口请求所需的请求头信息和输入参数信息，单击<调用接口>可以请求接口获取返回结果。页面的右侧展示了测试历史列表。从测试历史可以看出每次请求的耗时以及请求结果是否成功。

图2-17 API测试页面

2.1.5  API部署

API测试通过后，需要部署到网关进行代理，生成一个网关代理后的地址，外部访问该接口需要访问代理后的地址。网关主要用于访问接口时的认证鉴权、访问审计、访问控制等。

(1)     在[服务集成/API工厂/API管理]页面单击<部署>按钮弹出API部署窗口。

图2-18 API部署

(2)     API部署窗口，选择API网关转发节点，单击<部署>按钮后，即可完成API的部署。

(3)     API部署完成后，<部署>按钮会变为<撤消部署>按钮，单击<撤消部署>按钮可取消API的部署。

2.1.6  API授权

API授权是将API授权给组织内指定的工作空间，通过授权过的工作空间才能访问对应API，并且可以配置工作空间下的用户访问API时的访问规则和熔断规则。

(1)     在[服务集成/API网关/API列表]页面单击<授权>按钮进入API授权页面。

图2-19 API授权

(2)     API授权页面根据实际需要配置授权相关参数，需要配置的内容包括：

¡     选择工作空间：单击<选择工作空间>，勾选需要将API授权给的工作空间。

¡     字段选择：选择授权给工作空间的字段，数据API(字段筛选类型)在授权时会展示字段选择，其他API授权时页面不展示字段选择。

¡     选择规则模板：选择工作空间下的用户访问API时的访问规则。规则模板可在[API网关/规则管理]页面进行管理，规则模板的配置参见5.3  规则管理。

¡     选择熔断模板：选择工作空间下的用户访问API时的熔断规则。熔断模板可在[API网关/熔断管理]页面进行管理，熔断模板的配置参见5.4  熔断管理。

¡     认证方式：API注册时开启了认证，页面会出现该配置项，可选静态认证或动态认证。

-     静态认证：访问时需在请求头中携带认证ID及秘钥进行访问。

-     动态认证：访问时使用动态Token进行认证，可在[授权的API]页面查看API详情获取Token地址。

(3)     配置完成后，单击<授权>按钮，可以将API授权给所选的工作空间。

2.1.7  API的使用

API授权完成后，会在[授权的API]页面展示。在[授权的API]页面单击<测试>按钮可查看API的相关调用详情，包括请求路径、请求头等，用户可通过这些配置调用对应的API进行使用。

图2-20 API调用相关参数

2.2  服务编排

对于一个业务接口，如果想对接口的输出参数进行过滤，或者将多个接口的执行编排在一起，函数API可以实现这种场景，但是需要编写JS脚本，对人员要求较高，此时需要一种简便快速的方法来实现接口的编排。

服务集成的服务编排可以通过画布的方式，在页面利用拖拉拽来实现输出参数的过滤和多个接口的编排。

(1)     [服务集成/API工厂/服务编排]页面，单击<新增>按钮，填写基本信息，跳转到服务编排设计页面。

图2-21 服务编排设计页面

(2)     画布左侧包含基础组件和业务操作。

¡     基础组件可以拖入画布，用于关联组织内已经创建的工作空间。

¡     业务操作模块展示当前组织内所有的工作空间以及工作空间下的API目录树，可以对API目录进行过滤或根据API名称进行查询。业务API根据其所属工作空间可以拖入对应的工作空间组件中。

¡     画布上方包括触发器、连接器以及处理器。触发器包括Rest API组件，连接器包括数据源组件、HTTP请求组件以及HTTP响应组件，处理器包括分支判断组件、变量赋值组件、并行处理组件、数据拆分组件、数据筛选组件、脚本处理组件以及函数处理组件。其中Rest API组件、数据源组件HTTP请求组件以及HTTP响应组件只能拖入到基础组件内，即这几个组件在拖入画布的时候需要归属到某个工作空间组件中。

(3)     将组件添加到服务编排设计器中并建立连接。建立连接有两种方法：一是将鼠标放置在连线的起始组件上单击鼠标中键，拖拽连线至目标组件即可；二是右键单击连线起始组件，选择建立连接选项，拖拽连线至目标组件单击鼠标左键即可

(4)     不同组件配置不同，单击组件，页面右侧会弹出组件配置页面，用户可根据实际需要配置各组件的参数。

图2-22 参数配置

(5)     服务编排配置完成后，单击页面右上角的按钮，可对当前编排服务进行测试运行，页面会展示测试详情。窗口关闭后测试运行会自动结束，如果要启动该服务，需要在服务编排列表中单击<启动>按钮进行启动。测试运行时，如果请求头参数值为中文，需要传入UrlEncode编码之后的值。

图2-23 对编排后的服务进行测试。

(6)     服务测试完成后，在服务编排列表中单击<注册>按钮注册服务，注册时需选择该服务所属行业领域及API来源。服务注册后会以通用API展示在API管理页面，用户可在API管理页面对该API进行测试、部署、上线等操作。关于API的测试、部署、上线等操作的详情可参考2.1.4  2.1.5  2.1.6  2.1.7  等章节。

3 服务集成开放文件资源

用户可通过将文件资源上传到系统中实现文件资源在组织内的共享。

(1)     在服务集成模块下选择[文件管理/文件发布]，进入文件发布页面。文件发布页面通过向导式的设计将文件资源开放出去，以文件资源的形式对外提供下载功能。

(2)     在文档发布页面单击<文件注册>按钮，进入文件注册页面，配置文件注册的基本信息。

(3)     文件注册的基本信息配置完成后，单击<文件注册>按钮，配置文件注册的基本信息后，单击<下一步>按钮，进入文件管理页面。

(4)     选择文件：单击<选择数据源文件>按钮，弹出数据源文件列表，用户可选择需要的文件进行上传。

(5)     文件注册的文件管理信息配置完成后，单击<下一步>按钮，用户可以查看已填写文件注册的基本信息以及文件详情，确认没有问题后单击<保存>按钮即可完成文件的注册。

图3-1 文件预览

4 资产上线到资产市场

融合集成平台系统内存在多个组织，组织A发布的资产（API资产、文件资产）通过主动授权时只能授权给组织A内的工作空间使用，组织B如果想要使用组织A发布的资产，需要组织A先通过上线功能，将资产发布到资产市场，然后组织B在资产市场中进行订阅使用，下面以API资产为例说明资产上线到资产市场再到用户进行订阅的过程。

对于组织外的用户如果想使用本组织的API，则需管理员将API进行上线。用户通过“上线”功能将API发布到资产市场。然后其他部门用户可以在资产市场进行订阅，订阅审批通过后即可使用。整体配置流程如图4-1。

图4-1 API上线及订阅

表4-1 API上线及订阅流程说明

1. API上线

(1)     在[服务集成/API工厂/API管理]页面，将已经部署好的API进行上线。API管理页面，单击<更多>按钮，在下拉框中选择上线。

图4-2 API上线

(2)     下拉框中选择上线后弹出选择资产来源窗口，选择资产所属的来源名称。资产来源会关联组织管理员，资产上线后会展示在组织管理员的资产列表中。

图4-3 选择资产来源

(3)     选择资产来源后，单击<确定>按钮，系统会自动发出上线审批流程，API状态变为“上线审批中”。

(4)     上线审批流程会提交到组织管理员进行审批。组织管理员可在个人中心模块下[待办审批]页面中审批组织内用户提交的申请。

图4-4 管理员审批

(5)     组织管理员审批通过后，API状态变为“已上线”。

图4-5 公共资产页面

2. API上架

资产上线后会展示在组织管理员个人中心的资产管理列表中。资产管理员可在目录列表页面对资产进行上架，上架的资产会展示在资产中心下让其他用户使用。

(1)     资产管理员登录系统后，在个人中心模块下，选择左侧导航树中的[我的资产/资产管理]，进入资产管理列表页面。

(2)     页面中展示了当前资产管理员的所有资产，展示的信息包括资产名称、资产类型、资产状态、资产来源等。

图4-6 资产管理列表页面

(3)     单击<目录挂载>按钮，可选择未被挂载的目录，或者在目录挂载页面新增目录。

图4-7 目录挂载

(4)     资产进行目录挂载后，会展示在组织管理员[个人中心/我的资产/目录列表]中。在操作列表中，单击目录列表中对应资产操作中的<更多>按钮，选择“上架”，可将资产上架到资产市场。

(5)     资产上架后，会展示在资产市场中，用户可在资产市场中查看已上架的资产。

图4-8 公共资产页面

3. 订阅API资产

组织管理员将API资产上架后，所有用户都可在资产市场中查看到该API并进行订阅使用。

(1)     用户将鼠标悬浮在资产卡片上单击<订阅>按钮，弹出订阅对话框，选择订阅该资产的应用、订阅的周期、填写申请理由，然后单击<提交>进行订阅申请。用户提交订阅申请后，系统会创建一个订阅申请流程，该流程发送给组织管理员进行审批。

(2)     组织管理员可在[个人中心/待办审批]页面查看到待审批的流程。

(3)     组织管理员单击<同意>按钮，会弹出同意审批窗口，管理员填写处理意见后，用户订阅该资产成功。

(4)     组织管理员审批通过后，订阅者在[个人中心/资产订阅]页面可以查看审批通过的资产。

5 API管理

本章节介绍了用户注册API时需要用的一些配置，包括认证模板、服务分类、规则管理等，方便用户了解相关功能，更好的对API进行管理。

5.1  认证模板

在认证模板页面添加认证模板后，注册通用API时可关联认证模板，解决带动态认证接口的访问权限问题，自动帮用户维护接口访问所需认证授权信息，使用户更能专注于自己的业务。

(1)     在服务集成模块下选择[API工厂/认证模板]，进入认证模板页面。

(2)     在页面顶部导航栏中选择工作空间，认证模板页面显示对应工作空间下的认证模板信息。

(3)     认证模板页面单击<新增>按钮，进入新增认证模板页面，用户可根据实际需要新增认证模板。

图5-1 新增认证模板

(4)     部分参数说明如下：

¡     模板名称：认证模板的名称。

¡     URL：认证接口的请求地址，填写完整的url，例如：http(s)://域名/url或http(s)://ip:port/url。如果URL中含路径参数，请使用大括号包裹参数。

¡     请求方式：选择认证接口的请求方式，包括GET和POST。

¡     过期时间：根据认证接口返回的认证信息有效时间，可填写小于有效时间的值作为过期时间。

¡     描述：认证模板的描述信息，长度限制为不超过255个字符。

¡     请求头配置：认证模板的请求头信息。

¡     入参配置：认证模板的输入参数信息。入参支持表单参数、JSON参数。

¡     出参配置：获取认证模板的输出参数，选择认证信息对应的参数，选择认证信息到下个接口的传递类型，目前仅支持请求头传递和查询参数传递。

(5)     配置完成后，单击<保存>按钮完成认证模板的新增。

5.2  环境配置

环境配置功能主要用于函数API设计时工作空间秘钥和环境变量的获取。

·     密码箱管理

·     环境变量

1. 密码箱管理

密码箱功能主要用于函数API设计时对工作空间秘钥的获取。

(1)     在服务集成模块下选择[API工厂/环境配置/密码箱]，进入密码箱管理页面。

(2)     在页面顶部导航栏中选择工作空间，密码箱管理页面显示对应工作空间下的密码箱信息。

(3)     密码箱管理页面单击<新增>按钮，进入新增密码箱页面，用户可根据实际需要进行新增。

图5-2 新增密码箱

(4)     部分参数说明如下：

¡     名称：密码箱名称。

¡     KEY：密码箱的标识，后续可根据key获取到值，只允许输入中英文、数字和下划线，长度限制为不允许超过50个字符。

¡     密码：为密码箱配置对应的秘钥，长度限制为不允许超过200个字符。用户可根据该密码箱的实际使用需要手动输入配置秘钥；也可以单击<选择>按钮，选择工作空间后，该工作空间的秘钥会自动填充到该处。

¡     描述：密码箱的描述信息，长度限制为不超过128个字符。

(5)     配置完成后，单击<保存>按钮完成密码箱的新增。

2. 环境变量

环境变量功能主要用于函数API设计时获取环境变量。

(1)     在服务集成模块下选择[API工厂/环境配置/环境变量]，进入环境变量页面。

(2)     在页面顶部导航栏中选择工作空间，环境变量页面显示对应工作空间下的环境信息。

(3)     环境变量页面单击<新增>按钮，进入新增配置页面，用户可根据实际需要进行新增。

图5-3 新增环境变量

(4)     部分参数说明如下：

¡     KEY：环境变量的标识，只允许输入中英文、数字和下划线，长度限制为不超过20个字符。

¡     Value：配置环境变量的值，长度限制为不超过1023个字符。用户可根据该环境变量的实际使用需要手动输入配置环境变量的值；也可以在下拉框中选择融合集成平台内置的Kafka地址（消息集成模块使用的Kafka集群地址）。

¡     描述：环境变量的说明信息，长度限制为不超过128个字符。

(5)     配置完成后，单击<保存>按钮完成环境配置的新增。

5.3  规则管理

规则管理页面管理规则模板，供API授权的时候进行选择。规则的作用是限制API的访问方，可以设置访问的IP白名单、IP黑名单以及超限规则（指定时间内的访问次数）。

(1)     在服务集成模块下选择[API网关/规则管理]，进入规则管理页面。

(2)     规则管理页面单击<新增规则>按钮，进入新增规则页面，用户可根据实际需要新增规则。

图5-4 新增规则

(3)     部分参数说明如下：

¡     规则名称：规则模板的名称，只能输入中英文、数字或下划线，长度限制为不超过20个字符。

¡     规则类型：配置规则下包含的类型，包括IP白名单、IP黑名单和超限规则。不同规则类型所需配置参数不同。

¡     IP类型：规则类型选择IP白名单/IP黑名单时需配置该项，配置规则是对IP地址还是IP网段生效。

¡     超限类型：规则类型选择超限规则时需配置该项，包括秒级别、分钟级别、小时级别及天级别的访问次数控制。

¡     生效区间：规则模板的有效时间。

¡     规则描述：规则模板的描述信息，长度限制为不超过128个字符。

(4)     参数配置完成后，单击<确定>按钮，完成规则的新增。

5.4  熔断管理

熔断管理页面管理熔断模板，供API授权的时候进行选择。熔断的作用在于防止自身系统由于调用下游接口失败、超时等占用过多系统资源，导致雪崩。因此可以设置熔断进行系统保护。

(1)     在服务集成模块下选择[API网关/熔断管理]，进入熔断管理页面。

(2)     熔断管理页面单击<新增>按钮，进入新增熔断页面，用户可根据实际需要新增熔断。

图5-5 新增熔断模板

(3)     部分参数说明如下：

¡     熔断名称：熔断策略名称，只能输入中英文、数字或下划线，长度限制为不超过20个字符。

¡     熔断策略：可选“信号量隔离模式”和“线程隔离模式”。

¡     执行超时时间：执行超时时间。

¡     信号量隔离最大并发（个）：使用信号量隔离时的最大并发数。

¡     线程池大小：线程隔离模式下的线程池大小。

¡     熔断器开启阈值（个）：达到一定的请求量时熔断器才能工作。

¡     出错百分比阈值（%）：表示当出错率超过此值后，熔断器开始启动。

¡     熔断器工作时间（ms）：熔断器中断该时间后会进入半打开状态，部分流量可通过重试。

¡     描述：该熔断规则的描述信息，长度不能超过128个字符。

(4)     参数配置完成后，单击<确定>按钮，完成熔断模板的新增。