API数据连接

系统之间进行数据传输和交互，API 是最常见的解决方案之一。外部 API 数据如何才能接入本产品并进行分析呢？本文将介绍如何接入 API 数据连接，并利用连接创建数据集。
在连接数据之前，请收集以下信息：

• 数据库所在服务器的 IP 地址和端口号；

• 数据库的名称；

• 数据库的用户名和密码。

2.1 从数据连接新建

第一步：进入火山引擎，点击进入到某个具体项目下，点击数据准备，在下拉列表找到数据连接，点击数据连接。

第二步：在页面中选择 REST API 2.0

2.2 从数据集新建

第一步：进入火山引擎，点击数据准备-->数据集，选择左上角「新建」按钮，新建数据集。


第二步：添加数据连接的时候，点击其他。

第三步：在页面中选择 REST API 2.0

3.1 配置基本信息

首先，请您完成以下内容的配置：

（1）数据连接名称：支持自定义名称，或使用系统默认名称（例如：REST_API_2.0_时间戳）。
（2）URL 地址：需要连接的 API 的完整网址。
（3）请求方式：支持GET、POST两种请求方式。
（4）超时时间：输入请求在没有响应时等待的最长时间（单位：毫秒），默认为3分钟。
（5）重试次数：当请求失败，系统尝试重试的次数，最多支持5次。

其次，您若开启了分页配置，则可以设置起始页、请求间隔、最大分页及终止条件。

注意： 在设置终止条件时，支持写 groovy 表达式，实现通过当前请求的计算得到终止条件的场景。
示例：

• response.data.size()==0 代表当 response 下的 data 列表长度为0(空列表)时，停止分页。
• response.hasMore == false 代表当 response 下的 hasMore 为 false 时，停止分页。

3.2 配置参数

请您完成以下参数的设置：
（1）请求头：支持配置key、value，支持添加、删除操作，最多可配置10组。

（2）请求参数：输入API所需的所有查询参数。
（3）请求体：选择请求体类型（form-data或raw），均支持用户输入JSON格式的请求体。

（4）前置操作：
当您需要在主请求之前执行一些额外的步骤来准备数据或获取必要的信息时，可以通过该配置来完成。

• 添加前置操作：点击“新增前置操作”按钮，在配置页面需要输入前置操作的详细信息，包括URL地址、请求方式等。
• 解析请求与路径配置：点击“发起请求”后，系统将解析这个前置请求，并将解析结果呈现在「请求结果」区域，用户需要配置动态参数的key和结果字段路径，方便后续将前置请求结果应用于当前请求。
• 注意： 最多可以设置5个前置操作。

（5）后置操作：
提供一种更加灵活和强大的自定义参数配置方式，支持 groovy语法，支持用户编写代码实现多层次的请求解析。

3.3 解析请求与路径配置

首先，在完成上述配置操作后，您可以点击“发送请求”，系统将解析请求。
解析的顺序为「前置操作」>「当前请求」>「后置操作」，并将呈现「解析结果」。

其次，在系统完成解析请求后，您还需要完成以下内容进行路径的配置：

（1）字段路径：输入字段路径，使用$表示根节点，.号表示子节点。点击“获取字段”按钮，系统将解析并展示“字段配置”区域。

• 提示： 路径应指向Map或Array< Map >，若希望解析Array< Map >，需要在路径末尾加上.*
• 示例：
  • $.map1 代表取根节点下 map1 字段对应的数据。
  • $.array1.* 代表取根节点下 array1 字段对应的数据。

（2）字段配置：使用“添加”按钮支持新建字段，解析逻辑基于您输入的 rootPath 为基准，解析出结果。同时，支持删除已配置的字段。
（3）数据预览：点击“数据预览”按钮，支持查看当前选中字段的前100行明细数据。

3.4 测试连接与保存

最后，点击测试连接，即可进行数据源连通性测试。测试成功后，点击保存即可完成当前数据连接所有配置。