历史版本19 :API输入 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本说明

FineDataLink 版本功能变动
4.0.9

  • 请求类型为POST时，「请求参数」支持传入XML格式数据

  • 对于GET与POST请求，支持输出XML格式数据，支持预览XML响应结果。

4.0.10API交互优化、支持 text/plain 格式的请求内容
4.0.11API中 webservice 接口取数优化，详情参见：API 输入- webservice
4.0.13返回值格式优化，详情参见本文 2.2 节
4.0.17API 支持自定义认证
4.0.19API输入支持关闭SSL证书验证，详情参见API关闭证书验证
4.0.23

API 配置中的 body 请求内容支持使用 Content-Type 为 form-data 和 x-www-form-urlencoded 请求格式，

允许添加多行、每行均为自定义输入、支持引用参数，详情参见 功能说明中的Headers请求参数表格

1.2 应用场景

数据同步-API 支持将 API 中数据读取并同步至数据库中，但是对于取出的 API 数据，希望进一步进行数据处理后再同步至数据库，此时可以在数据转换中使用 API 输入，然后做数据处理后再同步至数据库。

1.3 功能说明

FineDataLink 支持在数据转换中使用 API 输入从 API 中取数，并对取出的 JSON 格式或者 XML 格式数据解析为二维表，然后使用其他数据转换中封装好的可视化算子对数据进行进一步处理和计算。

2. 前提条件编辑

  • 关于API 接口信息介绍，详情参见：API入门

  • 在使用 API 接口进行取数时，可以提前用 Postman 或者其他 API 调试工具进行测试，确保 API 的可用性。

3. 使用限制编辑

  • 若接口返回值为较简单的 JSON 格式，不需要复杂的解析处理，可直接使用，以便后续使用数据同步-API进行接口取数。

  • 当前 FineDataLink 内置的请求超时时间是10s，如果 API 查询返回时间超过 10s 将导致任务失败。若用户需要增大请求时间，可以使用 FDLTimeout 参数，详情参见：请求超时时间设置。

4. 功能概述编辑

功能概述与数据同步中的 API 数据源取数相同，详情参见：功能概述

5. 操作步骤编辑

数据同步-API 已经说明了请求参数为 JSON 数据格式的 API 取数，因此本文来介绍 XML 格式 API 用法。若需要使用请求参数为 JSON 数据格式的 API 取数，可移步 数据同步

5.1 前提条件

例如某接口可以返回每天化工产品的价格数据，想要将这些信息取出并进行进一步的解析加工。

首先测试该接口是否生效，如下图所示：

5.2 API 取数

新建定时任务，拖入数据转换节点并进入编辑界面，如下图所示：

拖入 API输入，将 API 地址 http://www.100ppi.com/index/xml/cindex_xml.php  输入，并填入验证方式和请求类型，由于我们想要取出当前日期前一天的数据，这里在参数中设置一个参数${date1}，如下图所示：

注1：若 API 地址是 https 开头，需要安装证书再使用该接口，否则会报错。

注2：部分用户的接口中，数据是用+号代替空格的，但在 FDL 中使用时，无需使用+号代替空格，否则会报错。

注：返回值格式为 JSON 时，可以填写自定义的 JSON 路径控制只返回结果中的单个 JSON 对象或者 JSON 数组，详情参见 返回值处理说明

然后返回数据转换节点外，设置date1的参数值为当前时间前一天，如下图所示：

点击「数据预览」，即可看到返回的日期前一天的 XML 格式的数据，如下图所示：

6. 后续操作编辑

接下来即可使用 XML解析 对取出的 API 数进行解析，将返回的XML格式数据解析为行列格式数据，以供后续加工存储。