如何对API数据做处理并接入山海鲸？

通过山海鲸数据管家 API 应用可以方便、快捷的对各种数据源进行整合和运算处理，生成 API 接口供山海鲸可视化项目调用。本文主要介绍在山海鲸数据管家中添加并处理 API 数据，然后将 API 接入山海鲸，具体操作如下：

1. 在数据管家中添加 API 数据

1.1 创建 API 应用

打开山海鲸数据管家，在“工作台”界面中点击“新建”，选择“新建应用”。

在创建应用界面选择“API 应用”，下方可以更改“应用名称”，设置完成后点击“创建”。

创建成功后会自动打开该 API 应用，可以设置相关的参数，在左侧的“API 设置”栏中可以新建或删除API，也可以查看当前 API 的调用地址。

在“授权访问”界面，可以更改“应用名称”、查看“应用 key”、“绑定域名”、添加“API 白名单”操作。（点击查看更多教程 →设置参数）

1.2 添加 API 数据

我们需要为API 应用添加数据，打开 API 应用的“数据设置”界面，可以看到“输入模块”、“整表处理”、“计算模块”三个模块板块，输入模块包含“导入数据表”、“导入 RPC”和“请求参数”，点击并拖动相应的模块至右侧操作界面就可以为 API 应用添加相应的数据。

下面以 Excel 数据源为例介绍，使用鼠标拖拽添加“导入数据表”模块至右侧操作界面，选择需要的 Excel 数据源表，点击”确定“。

教程中使用到的Excel 示例数据如下：

这里导入的字段为“时间”和“值”，通过鼠标拖拽操作可以将输入模块的“时间”、“值”和输出数据模块的输出字段相连接，这样就完成了一个将 Excel 数据源通过 API 输出的设置。

2. 处理 API 数据

添加 API 数据后，通过左侧的“整表处理”和“计算模块”板块可以处理 API 数据，整表处理包括“限制数量、筛选、合并、排序、聚合、转置”，计算模块包括“相加、相减、相乘、相除、最小、最大、常量、脚本、HTTP 请求、JSON 解析”。

下面将演示“筛选”、“脚本”和“HTTP 请求”模块操作，如需使用其他模块，请参考“模块”教程。

2.1 筛选数据

筛选数据是指根据特定条件或标准，可以基于一个或多个条件执行，从而在数据集中提取出符合要求的部分数据，下面介绍具体的操作步骤。

在前面我们已经添加了 API 数据，这里使用鼠标拖拽添加“筛选”模块至右侧操作界面，将它放在Sheet1 模块和输出数据模块的中间，方便后续的连接，如下图所示：

首先将Sheet1 模块和筛选模块的“Table”字段相连接，这样可以获取到 Excel 文件中的所有数据。

**【温馨提示】**筛选无论连接到表的哪个部分都会对整个表进行筛选，如下图所示：

然后在筛选模块中点击“＋”按钮可以设置筛选字段和筛选条件，可以添加多个条件，不设置筛选字段和筛选条件则默认输出空集。

然后在“FieldName”设置项中选择需要设置条件的字段，在下方设置筛选的条件，如下图所示：

最后将筛选模块与输出数据模块的输出字段相连接（点击“＋”按钮可以生成输出字段，也可以直接和“＋”按钮连接），这样就完成数据筛选后的输出，如下图所示：

【温馨提示】在筛选模块与输出数据模块的输出字段相连接时，选择连接Table 字段会输出多个 JSON 集合，如下图所示：

如果选择其中某项进行输出则会输出筛选过后的该项的集合，如下图所示：

2.2 脚本处理复杂运算

“脚本”是指一种按照特定格式和语法编写的程序代码，旨在自动化执行一系列命令或操作，添加**“脚本”模块后我们可以编写代码**来处理和输出相应的数据。

教程中使用到的Excel 示例数据如下：

参数的意义是接收连接端的数据，这里接收参数arg1并在代码中进行输出，如下图所示：

在输出数据中会得到参数 arg1 的所有内容，如下图所示：

Arg2，key1，key2等只要在脚本函数主体中没有出现，就不会影响脚本的运行。Key1和key2是作为输出的属性存在的，类似给输出的内容分类。

Arg 参数和key 输出都可以任意添加删除数量个更改名字，arg的value是默认值，如下图所示：

2.3 通过 HTTP 请求获取数据源

“HTTP 请求”是客户端与服务器之间通信的一种方式，当用户在浏览器中点击链接、提交表单或者应用通过网络获取数据时，都会发送 HTTP 请求到服务器，并根据响应内容显示页面或进行下一步处理，在计算模块中可以点击添加**“HTTP 请求”**模块。

如果没有特殊要求，只需要输入url再确认请求方式就可以获取数据。（点击查看相关教程 →如何将物联网设备数据存储到数据库中？）

如果需要动态的 url，并且需要输入“Header”和“body”（标识出来的地方是“body”），如下图所示：

静态模拟动态数据的示例代码如下：

1
2
3
4
5
6
7
8
9
10

// 静态模拟动态数据
function(arg1, arg2) {
  return {
    url: "http://8.140.112.186:1127/v1/app/8b516e4c-de30-4a25-bf3e-b4360388af32/437c513e/",
    Header: {
      Authorization: "Basic YWRtaW46cGFzc3dvcmQxMjM="
    },
    userName: "abc"
  }
}

在HTTP 请求中，“Header（头部）”是 HTTP 协议中非常重要的一个概念。它由一系列键值对组成，提供了关于请求、响应或连接的元数据信息。这些头部字段帮助客户端和服务器传递额外的信息，以支持请求的处理。在模块的下方可以连接Header，如下图所示：

3. 启动 API 应用

API 应用设置完成后，需要在应用左下角点击“保存”和“启动”应用，这样 API 就可以被正常调用了。如需停止 API 应用，请点击“停止”按钮。

API 应用设置完成后，选中一个需要调用的 API，在该 API 的“基础设置”界面复制“API 调用地址”。

将“API 调用地址”粘贴至浏览器查看输出数据，如下图所示：

4. 在山海鲸中接入 API 应用

关于在山海鲸中可视化接入 API 应用的设置，请参看教程 →连接 API

下面简单介绍一下步骤：打开山海鲸可视化，在数据源编辑窗口中，在左侧选择“添加新数据”选项卡，然后在右侧点击接口分类中的“API”按钮。

点击“API”按钮后会弹出输入“连接 API”的设置框，此处可以选择“GET”或“POST”请求，然后填入一个 API 地址。在下方可以设置 API 请求参数、认证、请求头和请求体。API 参数设置完成后，点击“发送”按钮后可以在界面下方查看“响应”是否正常。

如果 API 可以正常访问，点击“下一步”按钮进行“数据解析”和“数据预览”操作，点击可以查看相应教程，这里不进行具体的演示。

接入 API 应用后，点击右上角的“数据”栏目可以查看刚才添加的数据。

然后在下方的“看板公共数据”处就可以查看添加的 API 数据了。