安捷智用-使用手册

HTTP数据表

本文档介绍「HTTP数据表」的功能与操作。HTTP数据表通过调用外部 HTTP API 接口自动获取数据,将接口返回的 JSON 或 XML 结果转化为可供电子表格、BI 分析、AI 小智等产品场景使用的数据表,并支持可视化配置接口、授权连接复用、定时自动更新、数据加工等一系列能力。


1. 功能总览介绍

HTTP数据表适用于以下场景:

  • 外部业务系统已提供 HTTP API 接口,希望将接口数据接入平台进行报表分析

  • 数据量不大、更新频率要求不高,但需要定期自动同步的业务数据

  • 需要从多个三方系统拉取数据并统一整合分析

HTTP数据表的主要能力包括:

  1. 可视化配置接口:填写接口路径、请求方式、请求参数即可完成数据接入,无需编写代码
  2. 授权连接复用:通过预先配置的三方应用授权连接,统一管理 API 认证信息
  3. 定时自动更新:支持按分钟或按天定时抽取数据,也可手动立即更新
  4. 数据加工:接入后可对字段进行筛选和处理,满足分析需求


2. 新建HTTP数据表

2.1 进入新建页面

在顶部导航栏点击「数据空间」,默认进入「企业数据」页面。点击页面右上角的「新建数据集」按钮,在下拉菜单中选择「HTTP数据表」。

2.2 填写基本配置

在弹出的新建页面中,依次填写以下配置项:

配置项 是否必填 说明
数据表名 必填 给该HTTP数据表起一个容易识别的名称,如「部门档案表」
授权连接 必填 下拉选择已配置的HTTP API授权连接。授权连接来源于「三方应用连接」中类型为 HTTP API 的连接配置,如「FastBI接口授权」
请求方式 必填 选择 GET 或 POST,默认为 GET
接口路径 选填 填写具体的接口路径,如 /api/fdc/data/department/simplelist/。留空时直接使用授权连接配置的地址

授权连接的下拉选项来源于「三方应用连接」中已配置的 HTTP API 类型连接。如果下拉中没有您需要的连接,请先联系管理员在三方应用连接中完成配置。

HTTP API授权配置方式,见文档:HTTP API - 文档中心

2.3 配置请求参数(选填)

如果接口需要传递参数,可以在以下两个区域添加:

  • Query 参数:拼接在 URL 后面的查询参数,每组参数包含「名称」和「值」,点击「添加参数」可新增一行

  • Header 参数:请求头参数,同样以「名称-值」形式配置,适用于需要在 Header 中传递认证信息或其他自定义头的场景

2.4 配置返回数据解析

配置项 是否必填 说明
返回数据类型 必填 选择 JSON 或 XML,默认为 JSON
返回数据列表路径 选填 填写数据列表在接口返回结果中的路径,如 data.items。如果接口返回结果本身就是一个数据列表,此项可留空

2.5 配置分页

  • 不分页:接口一次性返回全部数据(默认)

  • 页码分页:如果接口支持分页返回,选择此项后平台会自动逐页拉取全部数据

2.6 测试接口并保存

配置完成后,点击页面底部的「测试接口」按钮。如果配置正确,页面右侧会显示「数据预览」区域,展示接口返回的数据样例,包括:

  • 接口状态码(如 200)

  • 请求耗时

  • 返回记录数

  • 数据预览表格

确认数据预览无误后,点击页面顶部的「确定」按钮,即可完成HTTP数据表的创建。

说明:点击「数据表草稿」可将当前配置保存为草稿,稍后继续编辑;点击「取消」则放弃当前配置。


3. HTTP数据表管理

在企业数据列表中点击已创建的HTTP数据表名称,即可进入数据表管理页面。页面顶部显示数据表名称、「HTTP数据表」标签以及创建用户信息,右上角提供「数据集详情」「数据加工」「编辑」三个入口。

3.1 数据预览

「数据预览」标签页默认展示接口返回的数据结果:

  • 页面显示「显示所有计算结果的前10行数据」,点击铅笔图标可查看或修改计算逻辑

  • 顶部提供「字段搜索」框,可快速定位需要查看的字段列

  • 点击「导出Excel」可将当前数据导出为 Excel 文件

  • 底部显示当前展示条数和总缓存条数,并支持分页浏览

3.2 数据字段

「数据字段」标签页展示数据表中所有字段的元信息:

  • 备注说明:显示该数据表的备注,点击编辑图标可添加或修改备注

  • 字段列表以表格形式展示,包含以下列:

列名 说明
序号 字段的排列顺序
原始名称 接口返回数据中的原始字段名
显示名称 在平台中展示的字段名称,默认与原始名称一致
字段类型 平台自动识别的字段类型,如「数字」「字符串」等

3.3 数据更新

「数据更新」标签页配置数据表的数据抽取策略:

页面显示当前的抽取模式(如「每天00:00自动抽取更新一次」),提供两个操作按钮:

  • 立即更新:点击后立即手动触发一次数据抽取

  • 修改:点击后弹出更新配置对话框,可修改以下内容:

配置项 说明
更新方式 选择「直连模式」或「抽取模式」。抽取模式下数据会缓存到平台本地,推荐使用
更新策略 抽取模式下可选择「每 N 分钟」自动抽取一次,或「每天 指定时间」自动抽取一次

3.4 数据加工

点击页面右上角的「数据加工」按钮,进入可视化数据加工页面:

  • 左侧为「选字段」面板,展示该数据表的所有字段,支持全选或按需勾选需要保留的字段

  • 右侧为「当前步骤结果」区域,点击「预览数据」可查看加工后的数据效果

  • 加工配置完成后,点击右上角「保存」生效;点击「返回」放弃修改并回到数据表详情页

数据加工的具体使用,可以参考文档:企业数据数据加工 - 文档中心

3.5 数据集详情

点击页面右上角的「数据集详情」按钮,弹出该数据表的基本信息窗口,包括:

  • 创建用户:创建该数据表的用户

  • 创建时间:数据表的创建时间

  • 最近编辑时间:最近一次修改配置的时间

  • 字段数:数据表包含的字段总数


4. HTTP数据表操作

在左侧目录树中,将鼠标悬停在某个HTTP数据表上,右侧会出现「...」更多操作按钮,点击后弹出操作菜单。此外,在右侧数据列表中,每行也直接提供了「编辑」和「删除」快捷按钮。

4.1 编辑

选择「编辑」,进入HTTP数据表的编辑页面。编辑页面的配置项与新建时一致,可修改数据表名、授权连接、请求方式、接口路径、请求参数、返回数据解析等所有配置。修改完成后点击「确定」保存。

4.2 重命名

选择「重命名」,可直接修改该数据表的名称,便于在数据表较多时进行管理和区分。

4.3 移动到

选择「移动到」,弹出文件夹选择对话框:

  • 对话框标题显示「将【数据表名】移动到」

  • 可在搜索框中输入文件夹名称快速定位

  • 选择目标文件夹后点击「确定」,即可将该数据表移动到指定文件夹下

  • 点击「取消」放弃操作

4.4 复制

选择「复制」,系统会基于当前HTTP数据表的配置创建一份副本,生成一个新的数据表。复制后的表会保留原有的接口配置和加工逻辑,但不会复制数据本身,可根据需要在此基础上修改配置。

4.5 删除

选择「删除」,系统会将该HTTP数据表从企业数据中移除。

注意:删除后该数据表将无法恢复,且依赖该数据表的报表将无法正常取数,请谨慎操作。