1. 概述
1.1 版本说明
FineDataLink 版本 | 功能变动 |
---|---|
4.0.9 |
|
4.0.10 | API交互优化、支持 text/plain 格式的请求内容 |
4.0.11 | API中 Webservice 接口取数支持读取WSDL文件,且自动生成请求参数、请求体 |
1.2 应用场景
用户想要将 Webservice 接口数据取出并进行后续的数据处理。
1.3 功能简介
FineDataLink 支持在数据转换中使用 API 输入将 Webservice 接口中的数据取出并对数据进行进一步处理。
在导入接口配置后,API 配置和 Headers、body 界面会自动生成请求参数与请求体,用户只需要对请求体中的参数填写具体值或引用参数,即可完成调用 WebService 接口的配置。
更多 API 相关详情参见:API 专题概述
注:目前仅支持参数为文本、数字、日期的 WebService 接口调用(最终都以文本形式传入),其他格式不支持。
2. 功能说明
2.1 导入WebService接口配置
「API 输入」算子中,点击「导入配置>导入WebService接口配置」,界面如下图所示:
注:仅当存在已选接口时,右下角的「确认」按钮才可用。
设置项 | 说明 |
---|---|
WSDL 解析方式 | 1)文件 支持直接上传用户已有的 WSDL 文件解析 2)URL 填写 WSDL 的 URL 地址,通过网址下载 WSDL 文件解析,不允许引用参数 |
接口选择 | 下拉时,解析 WSDL 文件,获取可调用的接口列表,作为「接口选择」下拉框可选项 |
重新打开任务再次进入该界面时:
1)如果解析方式选择的 URL,配置框项目全部为空,需要用户重新填写 WSDL 地址。
2)如果解析方式选择的文件,配置框项目全部为空,需要用户重新上传 WSDL 文件。
2.2 API配置界面
API 配置界面如下图所示:
配置项 | 说明 |
---|---|
请求方式 | POST/GET 如果一个接口可同时使用 POST 和 GET 调用,优先解析为 POST 请求方式 |
请求头 | SOAP 协议支持与使用优先级说明:如果 WebService 接口同时支持 SOAP1.1 和 SOAP1.2 ,则默认选取 SOAP1.1 协议进行解析 如果是SOAP1.1:Content-Type:text/xml; charset=utf-8(这里的字符集以解析到的字符集为准) 如果是SOAP1.2:Content-Type:application/soap+xml; charset=utf-8(这里的字符集以解析到的字符集为准) |
请求体 | 解析出的请求 XML,待填写项目用问号代替,例如: 对于需要传参的接口调用,在此处的 XML 中,需要用户将问号替换为实际参数值,支持通过${}引用 FDL 的参数 |
3. 操作步骤
3.1 前提条件
例如某 Webservice 接口可以返回不同城市的天气情况和基本信息,想要将这些信息取出并进行进一步的解析加工。
以下为获取到的请求地址、请求头和请求参数信息:
首先测试该接口是否生效,如下图所示:
3.2 API 取数
新建定时任务,拖入数据转换节点并进入编辑界面,如下图所示:
将 API输入拖入画布中,如下图所示:
点击节点,开始配置,由于是 Webservice 接口,因此可以点击导入,选择「导入Webservice 接口配置」,在导入配置界面中可以选择 WSDL 解析方式,示例中选择了 URL ,当然用户也可以选择文件方式,将 API 地址 http://www.webxml.com.cn/WebServices/WeatherWebService.asmx?WSDL 输入,注意 API 地址后需要加?WSDL,然后即可选择需要的接口。如下图所示:
点击「确定」后, API 配置和 Headers、body 界面会自动生成请求参数与请求体,用户只需要对请求体中的参数填写具体值或引用参数,即可完成调用WebService接口的配置,如下图所示:
注:如果 body 是SOAP1.1:Content-Type:text/xml; charset=utf-8(这里的字符集以解析到的字符集为准)。
如果是SOAP1.2:Content-Type:application/soap+xml; charset=utf-8(这里的字符集以解析到的字符集为准)。
然后可以修改请求体参数值,例如我们将「无锡」的天气情况数据取出,参数值修改为「无锡」的城市id:58354,如下图所示:
点击「数据预览」,即可看到返回的 XML 格式的数据,如下图所示:
4. 后续操作
接下来即可使用 XML解析 对取出的 API 数据进行解析,将返回的XML格式数据解析为行列格式数据,以供后续加工存储。