API专题

本文介绍 FDL 中包含的 API 相关功能及使用说明。FDL 中 API 相关功能如下：

• 读取 API 接口数据

• 将数据写入到 API 接口中

• 发布一个 API，供外部系统调用
  

「必做」使用 API 相关功能前，需确认是否注册了功能对应的功能点。详情请参见：注册简介

「建议查看右侧文档」详情请参见：API入门

了解：

• 什么是 API

• 接口说明、如何查看接口文档

• 如何在 FDL 中调用 API

3.1 相关功能

在 数据同步 节点、参数赋值 节点、API 输入 算子、参数输出 算子、全局参数-赋值参数 中，可调用第三方接口，获取数据。

3.1.1 读取接口数据

3.1.2 接口数据输出为参数

详情请参见：与参数功能配合使用说明

3.2 功能使用说明

具体设置项介绍可点击 3.1 节的文档查看。

API 取数在实际场景中的使用说明请参见：API取数使用说明

• 请求方法、接口地址、请求参数、认证类型、Body 请求内容、TLS/SSL 自签名认证可在 API 接口文档中获得，根据接口文档输入即可。接口文档示例：读取成员 接口

注：FDL 支持 GET 和 POST 两种请求方式，若您需要使用 PUT或者 DELETE 请求方法，POST 方法也能满足需求。

• 返回值处理：接口数据返回值如果是 JSON 格式，想要取出指定的 JSON 数组，可以使用「返回值处理」直接解析 JSON 数据。详情请参见：返回值处理说明

注：若 API 接口数据的返回值为 JSON 格式，一般与「JSON解析」算子配合使用，将数据解析后再做进一步处理/落库操作。

• 分页取数：可根据接口设置的分页方式进行取数。详情请参见：API输入-分页取数

• 调用频率控制：当用户设置当前 API 调用的频率限制时，可在一次执行实例中控制该 API 的调用频率。

• 响应字符编码：指定响应数据字符编码方式；支持 UTF-8、UTF-16、GBK 三种方式；将按照字符编码方式解析 API 响应数据

3.3 效果展示

可取出 API 接口数据。

3.4 实际应用

4.1 相关功能

可通过 API 输出 算子，将处理好的数据输出到 API 中。

一般与「JSON生成」算子配合使用，「JSON生成」算子可生成待调用接口的 body 数据。

4.2 实际应用

数据服务 功能，可以将加工、融合后的数据封装发布为规范化 API 接口数据，供外部系统调用，实现数据价值输出及共享开放。

数据服务最佳实践：

使用数据服务对数据进行分发管控

使用FineBI公共数据发布API