本文介绍 FDL 中包含的 API 相关功能及使用说明。FDL 中 API 相关功能如下：
读取 API 接口数据
将数据写入到 API 接口中
发布一个 API，供外部系统调用
1. 功能点注册
「必做」使用 API 相关功能前，需确认是否注册了功能对应的功能点。详情请参见：注册简介
2. API 入门
3. 读取 API 接口数据
3.1 相关功能
在 数据同步 节点、参数赋值 节点、API 输入 算子、参数输出 算子、全局参数-赋值参数 中，可调用第三方接口，获取数据。
3.1.1 读取接口数据
| 功能 | 说明 |
|---|---|
| 数据同步节点 | 1）若接口返回值为较简单的 JSON 格式，不需要复杂的解析处理，可直接使用数据同步-API进行接口取数 2）在「返回值处理」设置项中，填写 JSONPath 表达式，可获取指定的 JSON 数组
3）效果示例：
|
| API 输入算子 | 1）需要对取出的接口数据进行复杂处理 2）若接口数据为 JSON 格式，可以使用「JSON解析」算子进行解析，输出行列格式的数据后，再做进一步处理；同理，若为 XML 格式，可使用「XML解析」算子进行解析
|
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 实际应用
| 场景 | 方案 |
|---|---|
★★★★★ 当前 FineDataLink 内置的请求超时时间是10s，如果 API 查询返回时间超过 10s 将导致任务失败。若用户需要增大请求时间，可以使用 FDLTimeout 参数 | 使用FDLTimeout参数 |
| 在实际场景中如何使用 API 取数功能 | API取数使用说明 |
★★★★★ 用户需要从 API 接口取数，API 接口每次只能根据参数读取一条数据 | 需要将数据库的某列字段值逐个输出为参数，遍历所有参数从 API 接口取数 |
| API 数据可输出为参数，将参数传递给另外一个 API 使用，或者传递给 SQL 语句使用 | 参数赋值节点 |
★★★★★
| API取数概述 |
4. 将数据写入到 API 接口中
4.1 相关功能
可通过 API 输出 算子，将处理好的数据输出到 API 中。
一般与「JSON生成」算子配合使用，「JSON生成」算子可生成待调用接口的 body 数据。
4.2 实际应用
| 说明 | 文档 |
|---|---|
| 用户有些日程信息是通过 FR 填报到数据库或者保存到简道云中，原始信息可能会被其他部门进行增删改操作，因此用户希望将日程数据在企业微信中记录，方便在活动开始前对相关的同学做到自动提醒 | 活动日程信息更新至企业微信日程 |
| 用户希望根据业务数据库中的数据，更新、新增宜搭表单的数据 | 新增/修改宜搭表单数据 |
上一篇：最佳实践合集
