服务集成快速入门
服务集成模块支持将API、数据源和自定义函数封装成标准的RESTFul API对外提供并对外开放，并且支持文件资源的开放。
本章节通过完成一个使用服务集成模块开放API的配置样例；一个使用服务集成模块开放文件资源的配置样例，帮助您快速熟悉使用服务集成模块集成服务的过程。
使用服务集成模块开放API的步骤如下所示：
使用服务集成开放文件资源的步骤如下所示：
服务集成开放API
1. 步骤一：创建工作空间
工作空间是为了让用户更好的将项目相关资源进行统一管理。比如用户可以新建工作空间，然后将同一项目的相关资源创建在一个工作空间下，方便后续查看及操作。当用户登录系统后，如果系统中没有工作空间，页面会提示用户创建工作空；如果同组织下的用户已创建了工作空间，也可以直接使用。
在个人中心模块下，选择左侧的导航树中的[工作空间]，进入工作空间页面。
工作空间页面单击<新增>按钮，弹出新增工作空间页面，用户可根据实际进行新增。
图-1 新增工作空间
根据提示配置对应参数项的值，参数说明如下：
工作空间ID：必填，4-128位，仅支持以英文字母开头，可包含英文字母、数字、点号及下划线。
工作空间名：必填，4-128位，可包含汉字、英文字母、数字、点号及下划线。
认证类型：必选，支持私钥认证。
描述：非必填，长度0~128个字符。
单击<确定>按钮完成工作空间的新建。删除工作空间之前请先确认工作空间下的所有资源不再使用之后，先删除工作空间下的资源后再删除工作空间。
2. 步骤二：API注册
API注册用于将API注册到系统中，只有注册到系统中才能进行后续的部署、授权、上架等操作。当前服务集成模块支持三种API的注册。
数据API：数据API通过向导式的设计将数据库表里字段开放出去，以标准RESTFul接口的形式对外提供。
通用API：通用API设计用来对已经存在的第三方接口进行代理。
函数API：函数API可以在系统内通过编写javaScript脚本，设计并生成标准restful接口。
API注册具体步骤如下：
登录绿洲平台，在[融合集成/服务集成/API工厂/API管理]页面单击<API注册>按钮进行API的注册，用户可根据实际需要选择需要的API类型进行注册。
图-2 API类型选择
选择API注册类型后，进入API设计页面，用户需根据实际情况配置API相关信息。此处以通用API为例介绍下配置信息。
配置基本属性：
API名称：配置API名称，系统会自动对API名称进行重复校验，不允许同一工作空间内存在两个相同的API名称。
工作空间：选择API所属的工作空间。
行业领域：API的分类，标识当前API属于哪个行业领域，例如智慧城市，智慧园区。
API来源：API的业务场景，例如人脸识别，视频监控等。
API组：API所属的组。
描述信息：API的描述信息。
版本号：系统做了API版本管理的功能，所以API的版本号也不允许重复。
版本描述：当前版本的描述信息。
调用信息配置：
请求路径：以“/”开头的自定义访问路径，只能包含字母、数字、“-”、“.”、“/”等，如“/api/v1.0/api-test”。
接入类型：外部API和内部API，外部API主要是指第三方系统的接口，内部API目前主要是通过函数API生成的接口。
路由地址：接入外部API时填写完整的第三方接口地址，例如：http://ip:port/url；接入内部API时选择相应的函数API。
请求方式：选择接口的请求方式，外部API可以选择GET/POST/PUT/DELETE，内部API目前只支持POST和GET。
认证模板：接入第三方接口时，如果该接口带认证，则需要在[API工厂/认证模板]中添加认证模板，然后在此处选择认证模板，如果该接口不带认证，则不需要选择认证模板。
请求参数格式：请求参数的格式，目前是JSON格式，不可修改。
返回参数格式：返回参数的格式，目前是JSON格式，不可修改。
请求头配置：填写接口的请求头信息。
入参配置：配置入参的字段名和数据类型等信息，需根据第三方API入参进行填写。
出参配置：配置出参的字段名和数据类型等信息，需根据第三方API入参进行填写。
错误码：填写接口请求出错时的错误码信息。
在预览完成页面，用户可以查看已填写的API的基本信息以及参数配置信息，核对后保存即完成API的注册。
图-3 API设计（此处通用API为例，不同API设计页面不同）
配置完成后，单击<保存>按钮，可完成API的注册。在API管理页面的API列表中可以查看注册完成的API。
图-4 API列表
3. 步骤三：API测试
API注册完成后，需通过API测试功能来测试注册完成后的API是否正确，只有通过测试的API才能进行部署。
在[融合集成/服务集成/API工厂/API管理]页面单击<测试>按钮进入API测试页面。
图-5 API测试页面
在测试页面可以查看API的基础信息，包括API名称、请求方式、请求路径、请求头配置和请求参数配置。填写接口请求所需的请求头信息和输入参数信息，单击<调用接口>可以请求接口获取返回结果。页面的右侧展示了测试历史列表。从测试历史可以看出每次请求的耗时以及请求结果是否成功。
4. 步骤四：API部署
API测试通过后，需要部署到网关进行代理。
在[融合集成/服务集成/API工厂/API管理]页面单击<部署>按钮弹出API部署窗口。
图-6 API部署
API部署窗口，选择API网关转发节点，单击<部署>按钮后，即可完成API的部署。
API部署完成后，<部署>按钮会变为<撤消部署>按钮，单击<撤消部署>按钮可取消API的部署。
5. 步骤五：API授权
API授权是将API授权给组织内指定的工作空间，通过授权过的工作空间才能访问对应API。
在[融合集成/服务集成/API网关/API列表]页面单击<授权>按钮进入API授权页面。
图-7 API授权
API授权页面根据实际需要配置授权相关参数，需要配置的内容包括：
选择工作空间：单击<选择工作空间>，勾选需要将API授权给的工作空间。
字段选择：选择授权给工作空间的字段，数据API(字段筛选类型)在授权时会展示字段选择，其他API授权时页面不展示字段选择。
选择规则模板：选择工作空间下的用户访问API时的访问规则。
选择熔断模板：选择工作空间下的用户访问API时的熔断规则。
配置完成后，单击<授权>按钮，可以将API授权给所选的工作空间。
6. 步骤六：API上架
对于组织外的用户如果想使用本组织的API，则需管理员将API进行上架。用户通过“上架“功能将API发布到资产市场。上架时会发出一个审批流程，管理员审批通过后，API才能发布到资产市场中。
在[融合集成/服务集成/API工厂/API管理]页面，单击<更多>按钮，在下拉框中选择上架，系统会自动发出上架审批流程，API状态变为“上架审批中”。
图-8 API上架
上架审批流程会提交到管理员进行审批。管理员审批通过后，API状态变为“已上架”，用户可在[资产市场/服务]页面查看已上架的资产。
图-9 资产市场
7. 步骤七：订阅
API上架到资产市场后，用户可在资产市场对其他用户发布的API进行订阅。订阅时会发出一个审批流程，管理员审批通过后，订阅者才能查看到该API的具体调用信息，然后进行访问。
在[资产市场/服务]页面，将鼠标悬浮在API资产卡片上，资产卡片上出现<订阅>按钮，单击该按钮，弹出订阅窗口，配置需要使用该资产的工作空间、申请理由等信息，然后单击<提交>按钮，系统会将该订阅流程提交管理员进行审批。
图-10 订阅申请
订阅申请会提交到管理员进行审批。
图-11 管理员审批
管理员审批通过后，用户可在“我的订阅”页面，查看自己审批通过的订阅。单击<详情>按钮，可查看API能力的详情并进行使用。
服务集成开放文件资源
1. 步骤一：创建工作空间
工作空间是为了让用户更好的将项目相关资源进行统一管理。比如用户可以新建工作空间，然后将同一项目的相关资源创建在一个工作空间下，方便后续查看及操作。当用户登录系统后，如果系统中没有工作空间，页面会提示用户创建工作空；如果同组织下的用户已创建了工作空间，也可以直接使用。
在个人中心模块下，选择左侧的导航树中的[工作空间]，进入工作空间页面。
工作空间页面单击<新增>按钮，弹出新增工作空间页面，用户可根据实际进行新增。
图-12 新增工作空间
根据提示配置对应参数项的值，参数说明如下：
工作空间ID：必填，4-128位，仅支持以英文字母开头，可包含英文字母、数字、点号及下划线。
工作空间名：必填，4-128位，可包含汉字、英文字母、数字、点号及下划线。
认证类型：必选，支持私钥认证。
描述：非必填，长度0~128个字符。
单击<确定>按钮完成工作空间的新建。删除工作空间之前请先确认工作空间下的所有资源不再使用之后，先删除工作空间下的资源后再删除工作空间。
2. 步骤二：文件注册
文件注册用于将文件注册到系统中，只有注册到系统中才能进行后续的上架、订阅等操作。
登录绿洲平台，在[融合集成/服务集成/文件管理/文件列表]页面单击<文件注册>按钮进行文件的注册。
图-13 文件注册
文件注册页面，用户可根据实际需要进行配置。
配置基本属性：
名称：文件资源的名称。
工作空间：文件资源所属的工作空间。
描述：文件资源的描述信息。
图标：选择文件资源的展示图标，可选择系统默认的图标或者自己上传。
版本号：文件资源的版本号。
版本描述：文件资源的版本描述。
文件管理：
选择文件：选择“文件资源”模块中已上传的文件资源，或者单击<上传>按钮选择上传文件。
文件介绍：文件介绍信息。
数据样例：文件资源数据示例信息。
在预览页面，用户可以查看已填写文件注册的基本信息以及文件详情，确认没有问题后单击<保存>按钮完成文件的注册。
配置完成后，单击<保存>按钮即可完成文件注册。
3. 步骤三：文件授权
文件注册完成后通过“授权”功能，将文件资源授权给指定同一组织内的工作空间。被授权的工作空间可查看文件资源详情并进行下载。
在[融合集成/服务集成/文件管理/文件列表]页面单击<授权>按钮进入文件授权页面。
图-14 文件授权
文件授权页面单击<选择工作空间>，勾选需要将文件授权给的工作空间。配置完成后，单击<授权>按钮，可以将文件授权给所选的工作空间。
4. 步骤四：文件上架
对于组织外的用户如果想使用本组织的文件，则管理员需将API进行上架。用户通过“上架“功能将文件发布到资产市场。上架时会发出一个审批流程，管理员审批通过后，文件资源才能发布到资产市场中。
在[融合集成/服务集成/文件管理/文件列表]页面，单击<更多>按钮，在下拉框中选择上架，系统会自动发出上架审批流程，API状态变为“上架审批中”。
图-15 文件上架
上架审批流程会提交到管理员进行审批。
图-16 管理员审批
管理员审批通过后，文件状态变为“已上架”，用户可在[资产市场/数据]页面查看已上架的文件。
图-17 资产市场
5. 步骤五：文件订阅
文件上架到资产市场后，用户可在资产市场对其进行订阅。订阅时会发出一个审批流程，管理员审批通过后，订阅者才能下载该文件然后进行使用。
在[资产市场/数据]页面，将鼠标悬浮在文件资产卡片上，资产卡片上出现<订阅>按钮，单击该按钮，弹出订阅窗口，配置需要使用该资产的工作空间、申请理由等信息，然后单击<提交>按钮，系统会将该订阅流程提交管理员进行审批。
图-18 订阅申请
订阅申请会提交到管理员进行审批。管理员审批通过后，用户可在“我的订阅”页面，查看自己审批通过的订阅。单击<详情>按钮，可下载文件并进行使用。