通用 REST 连接
通用 REST 连接可将 PlaidCloud 连接到任何没有专用连接器的 HTTP/REST 服务。它支持常见的身份验证方式(无、基本、API 密钥、持有者令牌、OAuth 2.0)、默认请求标头、细粒度的重定向和传输处理,以及表单内的请求测试器。
转换器(例如 Savant 导入器)可以创建保存加密机密值的 REST 连接。它们所转换的步骤会在运行时使用这些值。
该表单有四个选项卡。
连接详细信息
Section titled “连接详细信息”| 字段 | 类型 | 说明 |
|---|---|---|
| 连接名称 | 文本 | 此连接的显示名称。 |
| 备注 | 文本(多行) | 关于该连接的可选备注。 |
| 主机或 IP 地址 | 文本 | 请求所指向的基础主机。 |
| 启用(允许访问) | 开关 | 是否启用该连接。禁用可暂停连接而不删除。 |
| 身份验证类型 | 选择 | None、Basic、API Key、Bearer Token、OAuth 2.0、Azure Cosmos DB (Master Key) 或 Azure Cosmos DB (Microsoft Entra ID)。选择某个类型会启用身份验证选项卡上对应的分组。 |
| 安全模型 | 选择 | 谁可以使用该连接:私有、指定成员、指定安全组或所有工作区成员。 |
| 设置 | 默认 | 说明 |
|---|---|---|
| 启用 SSL 证书验证 | 关 | 发送请求时验证 SSL 证书。验证失败会中止请求。 |
| 自动跟随重定向 | 开 | 将 HTTP 3xx 响应作为重定向跟随。 |
| 沿用原始 HTTP 方法 | 关 | 使用原始 HTTP 方法重定向,而不是默认的使用 GET 重定向。 |
| 沿用 Authorization 标头 | 关 | 发生重定向时保留 authorization 标头。 |
| 重定向时移除 Referer 标头 | 关 | 发生重定向时移除 referer 标头。 |
| 启用严格 HTTP 解析器 | 关 | 拒绝 HTTP 标头无效的响应。 |
| 自动编码 URL | 开 | 对 URL 的路径、查询参数和身份验证字段进行编码。 |
| 禁用 Cookie 存储 | 关 | 不将此请求的 Cookie 存入 Cookie 存储,也不将已存储的 Cookie 作为标头发送。 |
| 握手时使用服务器密码套件 | 关 | 握手期间使用服务器的密码套件顺序,而不是客户端的顺序。 |
| 最大重定向次数 | 10 | 跟随重定向次数的上限。 |
API 定义
Section titled “API 定义”可选。将 API 的 OpenAPI 3.x 或 Swagger 2.0 定义附加到连接上,之后任何使用该连接的 REST 请求步骤都可以列出该 API 的端点,并自动填入其方法、参数和请求正文,而无需在每个步骤中重复指定该定义。
| 字段 | 类型 | 说明 |
|---|---|---|
| 定义 | 选择 | None、OpenAPI / Swagger URL 或 OpenAPI / Swagger file。 |
| 定义 URL | 文本 | 规范的发布地址,例如 https://api.example.com/openapi.json。选择 URL 时显示。 |
| 定义文件 | 文件 | 存储在 Document 中的 .json 或 .yaml 规范。选择文件时显示。 |
在 REST 请求步骤中,选择此连接,将端点来源设置为来自连接的 API 定义,然后选择加载目录。
仅显示与所选 Authentication Type 对应的分组。选择 None 时,该选项卡被禁用。
基本
| 字段 | 类型 | 说明 |
|---|---|---|
| 用户 | 文本 | 基本身份验证的用户名。 |
| 密码 | 密码 | 基本身份验证的密码(只写)。 |
API 密钥
| 字段 | 类型 | 说明 |
|---|---|---|
| 键 | 文本 | API 密钥字段名称。 |
| 值 | 文本 | API 密钥值。 |
持有者令牌
| 字段 | 类型 | 说明 |
|---|---|---|
| 令牌 | 密码 | 持有者令牌(只写)。 |
OAuth 2.0
| 字段 | 类型 | 说明 |
|---|---|---|
| 将身份验证数据添加到 | 选择 | 通过 Request Headers 或 Request URL 发送身份验证数据。 |
| 标头前缀 | 文本 | authorization 标头值的前缀(默认为 Bearer)。 |
| 身份验证 URL | 文本 | 授权端点。 |
| 访问令牌 URL | 文本 | 令牌端点。 |
| 客户端 ID | 文本 | OAuth 客户端标识符。 |
| 客户端密钥 | 文本 | OAuth 客户端密钥。 |
| 刷新令牌 URL | 文本 | 用于刷新令牌的端点。 |
| 初始刷新令牌 | 文本 | 首次交换时使用的初始刷新令牌。 |
| 其他令牌请求参数 | 表 | 令牌请求中发送的额外正文参数(Enabled、Name、Value、Description)。 |
| 其他令牌请求标头 | 表 | 令牌请求中发送的额外标头(Enabled、Name、Value、Description)。 |
Azure Cosmos DB (主密钥)
| 字段 | 类型 | 说明 |
|---|---|---|
| 主密钥 | 密码 | Cosmos DB 账户的主密钥(只写)。按 Cosmos DB REST API 的要求,每个请求都使用它进行签名。 |
Azure Cosmos DB (Microsoft Entra ID)
| 字段 | 类型 | 说明 |
|---|---|---|
| 访问令牌 URL | 文本 | 您租户的令牌端点,例如 https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token。 |
| 客户端 ID | 文本 | Entra 应用程序的客户端 ID。 |
| 客户端密钥 | 密码 | Entra 应用程序的客户端密钥(只写)。 |
将 Cosmos DB 连接与 REST Request 步骤搭配使用,可查询容器中的文档并写入文档。请将连接的基础 URL 设置为 Cosmos DB 账户端点。
通过此连接发送的每个请求都会携带的标头表。每行包含 Enabled、Header Name、Value 和 Description。使用行按钮可添加、插入和删除标头。这些标头会随该连接发出的每个请求一起发送,包括分页读取的每一页以及逐行扇出时的每个请求;在单个步骤上设置的同名标头优先于此处的标头。
通过已保存的连接发送一个临时请求,以确认其可正常工作。
| 字段 | 类型 | 说明 |
|---|---|---|
| 测试端点 | 文本 | 要调用的完整 URL(例如 https://example.com/rest/test/validate)。 |
| 方法 | 选择 | GET、PUT、POST、DELETE、HEAD 或 OPTIONS。 |
| 负载 | 代码 | 请求正文。支持 Django/Jinja 风格的模板标记。 |
| 发送测试请求 | 按钮 | 发送请求并显示响应(或错误)。 |
- REST 连接器 — Salesforce、NetSuite、Workday 及其他 REST 服务的专用连接器。
- 导入 Samsara 数据 — 适用于使用游标分页的 API 的可直接复制的方案。
- 创建和管理连接
- REST 请求工作流步骤