API数据源
创建
步骤1：点击创建数据源，选择“创建API数据源”。
步骤2：在“创建API连接”页面中填写以下信息：
名称：自定义数据源名称；
请求方式：URL请求方法，GET/POST按接口要求选择；
URL地址：URL请求地址；
描述：可以对创建的数据源进行描述。
步骤3：根据需求维护，有参数的Rest API，选择新增入参。如接口不需要，则不需要填。
填入参数名称、描述和参数值，选择类型（NUMBER/DATE/STRING）、是否必传、动态传参，然后点击“保存”。
步骤4：填写完成后，点击“校验”。点击后，系统会校验连接信息的正确性，如果校验成功，则显示返回字段；如果校验失败，则返回提示信息。
步骤5：点击“保存并连接”，完成API数据源的添加。
动态入参设置（在新增入参里）
| 系统参数 | 待选值：设备ID 模型ID 租户ID 用户ID 场景示例：用户点击某设备，把这个设备ID带入详情页面，从而影响详情页面的数据时 |
| 组件传参 | 参数是通过别的组件的值传过来的，比如说 时间筛选器影响使用了这个API的组件，那时间就是通过别的组件过来的，这个地方就需要选组件传参 |
| URL传参 | 例如：有个模型首页，这个首页会给到子租户，然后子租户通过这个链接直接访问首页， 但是首页里面有个自定义的接口需要传“tenantName”，可以直接在首页发布出来的URL上加上这个字段的名称。在这种场景下，动态入参选择URL传参，URL参数输入“tenantName” |
查看详情
在数据源主页，点击数据源名称，查看数据详情。
点击API数据详情页面右上角的“
”，可以选择“删除/编辑/更新速度/查看”。
删除
删除：可以删除当前数据。
编辑
编辑：可以对当前数据进行编辑，修改配置。具体步骤同“创建API数据源”。
更新速度
更新速度：可以设置数据源更新速度。
更新间隔：
前端向后端发送请求的频率，后端获取数据时的超时时间
如果在云视界向对方api发出请求，设置为1s，如果对方在1s内返回数据了，
我们就取数，超出1s弃数
配额
高速：更新时间范围1s-3s,默认最大创建3个。
中速：更新时间范围4s-5min,默认最大创建5个。
低速：更新时间范围5min以上,默认为低速，数量不限制。
查看连接信息
查看：用户自定义的API数据源，支持查看连接信息。
查看/更新字段类型
API格式示例
入参格式举例
{
"startTime": "2020-12-01 00:00:00",
"endTime": "2020-12-14 18:48:14",
"serviceType": "",
"complete": ""
}
入参注意事项：
1. 入参时间格式必须为：2020-12-01 00:00:00;
2. 请求方式支持get和post;
3. 4.0不支持请求头入参；请求头中默认携带了根云平台4.0的Cookie，用作用户鉴权。
出参格式举例
[ {
"startTime": "2020-12-01 00:00:00",
"endTime": "2020-12-14 18:48:14",
"contract" : 0,
"customerName" : "测试客户",
"workSheet" : 428.0
}, {
"startTime": "2020-12-01 00:00:00",
"endTime": "2020-12-14 18:48:14",
"contract" : 0,
"customerName" : "客户",
"workSheet" : 420.0
}]
出参注意事项：
1. 返回数据格式为[{},{}],其中不得有嵌套;
2. 出参时间格式必须为：2020-12-01 00:00:00;
认证规则与数据结构转换
认证规则
客户可以通过手动维护第三方系统的鉴权规则(静态规则、动态规则)，便于云视界组件直接引用第三方数据源数据。
主要创建步骤为：
1、添加规则，维护规则名称、规则类型等基本信息，包含对认证鉴权规则字段的设置，创建成功后，在api数据源创建的时候可选。
2、在列表页面，点击【编辑】，维护规则的定义信息；点击【详情】，可查看该规则已定义信息。
创建
静态规则默认按照配置进行参数转发；动态规则按照配置的鉴权配置进行动态接口调用，对鉴权接口中定义的源参数配置进行转发。**
认证规则列表页
认证规则-静态规则新增页
认证规则-动态规则新增页
在页面中点击【添加规则】，在维护页面设置规则信息。
| 字段名称 | 是否必填 | 长度（字符） | 内容/限制 | 说明 |
|---|---|---|---|---|
| 规则基本信息 | ||||
| 规则名称 | 是 | 100 | 字符串，唯一 | 作为api数据源引用名称 |
| 规则类型 | 是 | 8 | 字符串 | 单选，静态/动态 |
| 静态规则-源参数定义 | ||||
| 参数名称 | 是 | 64 | 字符串 | |
| 参数类型 | 是 | 8 | 字符串 | 下拉框，String/Integer/Date/Double |
| 是否必选 | 否 | 1 | 整数 | 下拉框，是/否 |
| 传递方式 | 是 | 32 | 字符串 | 下拉框，body/header/param/rest |
| 解密方式 | 否 | 16 | 字符串 | 下拉框，base64/JWT |
| 静态规则-目标参数定义 | ||||
| 源参数 | 是 | 64 | 字符串 | 下拉框，源参数定义列表中源参数 |
| 目标参数 | 是 | 64 | 字符串 | |
| 参数类型 | 是 | 8 | 字符串 | 下拉框，String/Integer/Date/Double |
| 是否必选 | 否 | 1 | 整数 | 下拉框，是/否 |
| 传递方式 | 是 | 32 | 字符串 | 下拉框，body/header/param/rest |
| 动态规则-鉴权信息 | ||||
| 鉴权地址 | 是 | 500 | 字符串 | 第三方鉴权地址url地址 |
| 请求类型 | 是 | 16 | 字符串 | 下拉框，get/post |
| 认证缓存 | 是 | 1 | 整数 | 下拉框，是/否 |
| 动态规则-鉴权入参 | ||||
| 参数名称 | 是 | 64 | 字符串 | |
| 参数类型 | 是 | 8 | 字符串 | 下拉框，String/Integer/Date/Double |
| 是否必选 | 否 | 1 | 整数 | 下拉框，是/否 |
| 默认值 | 否 | 128 | 字符串 | 第三方鉴权字段默认值 |
| 传递方式 | 是 | 32 | 字符串 | 下拉框，body/header/param/rest |
| 加密方式 | 否 | 16 | 字符串 | 下拉框，base64、MD5 |
| 动态规则-源参数定义 | ||||
| 参数名称 | 是 | 64 | 字符串 | |
| 参数类型 | 是 | 8 | 字符串 | 下拉框，String/Integer/Date/Double |
| 是否必选 | 否 | 1 | 整数 | 下拉框，是/否 |
| 传递方式 | 是 | 32 | 字符串 | 下拉框，body/header/param/rest |
| 解密方式 | 否 | 16 | 字符串 | 下拉框，base64/JWT |
| 动态规则-目标参数定义 | ||||
| 源参数 | 是 | 64 | 字符串 | 下拉框，源参数定义列表中源参数 |
| 目标参数 | 是 | 64 | 字符串 | |
| 参数类型 | 是 | 8 | 字符串 | 下拉框，String/Integer/Date/Double |
| 是否必选 | 否 | 1 | 整数 | 下拉框，是/否 |
| 传递方式 | 是 | 32 | 字符串 | 下拉框，body/header/param/rest |
| 名称 | Y | 所有数据源保持一致 | 所有数据源保持一致 | |
| 描述 | N | 所有数据源保持一致 | 所有数据源保持一致 |
编辑
可以对已有的规则进行修改，规则跟新增相同。
api数据源引用
维护了第三方api系统的鉴权规则后，可以在api数据源中直接进行引用。
维护选择api数据源中认证规则后，在云视界组件调用api数据源时，会自动按照配置规则进行模拟鉴权，便于正常访问第三方接口。
数据结构转换
客户可以通过手工维护数据结构转换规则，提取数据中想要并便于解析的数据格式，云视界组件数据源中直接引用数据格式转换。
主要创建步骤为：
1、添加规则，维护规则名称、提取数据类型等基本信息，以及要提取的数据字段，创建成功后，在api数据源创建的时候可选。
2、在列表页面，点击【编辑】，维护规则的定义信息；点击【删除】，可删除该规则已定义信息。
创建
用户可以手动数据格式转换规则，使云视界配置的数据源中返回的数据格式进行提取和转换。
| 字段名称 | 是否必填 | 长度（字符） | 内容/限制 | 说明 |
|---|---|---|---|---|
| 规则基本信息 | ||||
| 规则名称 | 是 | 100 | 字符串，唯一 | 作为api数据源引用名称 |
| 提取类型 | 是 | 8 | 字符串 | 单选，数组/对象 |
| 转换器规则 | ||||
| 提取字段 | 是 | 64 | 字符串 | 多级可用英文符号的“.”例如”a.b.c”最多三级 |
| 重命名 | 是 | 64 | 字符串 | 只有转换为对象的时候可以重命名 |
| 数据源格式 | Json | 即将被转换的数据格式 | ||
| 目标格式 | Json | 转换后的json |
编辑
可以手动编辑数据规则。**
api数据源引用
在api数据源中可以直接进行引用。
根据选定的数据格式转换规则，会在调用接口后，将返回的数据按照指定的规则进行转换。
示例：
认证规则配置：
鉴权地址：[http://ntc-amc-web.bdn-ntc-dev.rootcloudapp.com/ntc-basis/api/auth/userLogin](http://ntc-amc-web.bdn-ntc-dev.rootcloudapp.com/ntc-basis/api/auth/userLogin)
请求类型：post
鉴权入参：
tag：supper
username：185******
password：XSg******
源参数定义：
data：string
目标参数定义：
Cookie：data
数据结构转换示例：
源数据格式：
{
"total":39,
"code":"OK",
"data":
[
{
"repaymentPeriod":"1",
"purchasePrice":"100.00"
}
]
}
Api数据源配置
名称：ntc_dev_product_list
请求方式：POST
url地址：http://ntc-amc-web.bdn-ntc-dev.rootcloudapp.com/ntc-service-assets/api/product/page
认证规则：ntc_dev
结构转换：ntc_dev_get_list