各类集成凭证的配置说明|飞书低代码平台

概述

在应用的开发后台，进入「第三方集成」列表，我们可以看到所支持的多种连接配置，包含但不限于：OData / Webhook / HTTP 等。通过创建连接配置，可以实现与第三方服务连通，供应用各处使用。

250px|700px|reset

这些连接服务的连接配置信息，该如何理解与配置？下面将做整体介绍。

连接配置的创建步骤

创建入口：开发后台 → 集成连接配置 → 第三方集成 → 新建。

250px|700px|reset

新建连接配置后，将跳出弹窗，此时我们需要选择“连接配置所连接的服务”。

例如：当需要在流程中使用 HTTP 请求节点，并需要按服务器系统规定的连接配置发送请求时，此处“新建连接配置”就需要选择 HTTP。

250px|700px|reset

选择好连接的服务，下一步就需要配置不同连接服务对应连接信息。所有连接服务对应的连接配置，都需要填写「名称」和「API 名称」：

名称：支持多语

API 名称：是在代码中的唯一标识，系统会自动生成，可编辑，但需要在应用内唯一

250px|700px|reset

连接配置信息支持多环境配置：可以分别配置“开发环境”和“线上环境”使用的连接配置信息（若使用相同的连接配置，则两处配置信息保持一致即可）

250px|700px|reset

不同连接配置的具体说明

不同连接服务对应的连接配置，所需的连接配置信息也不尽相同。接下来，将分别介绍目前已支持的各类连接配置，及其配置项说明。

注意：若你的应用内没有以下介绍的某个连接配置，说明该连接配置对当前应用不可见，或仅支持部分租户使用。

OData

250px|700px|reset

连接配置信息配置项说明：

配置项	说明
鉴权方式	目前仅支持基于用户名、密码的鉴权方式（Basic Auth）
数据源 URL	外部数据源对应的 URL（需要填写 OData 服务根目录的 URL，以「/」结尾），例如：https://services.odata.org/V4/Northwind/Northwind.svc/ （该 demo 数据源无需用户名和密码）
用户名	数据源 URL 对应的用户名
密码	数据源 URL 对应的密码

Webhook

250px|700px|reset

连接配置信息配置项说明：

配置项	说明
鉴权方式	选择 HTTPS 身份认证的鉴权类型，可选项：Access Token 和 Bearer Token Access Token 的有效时间为 2 小时，Bearer Token 永久有效。建议选用安全级别较高的 Access Token。
若选择了 Access Token 鉴权方式，会显示「Access Key」	系统自动生成，无需配置，支持编辑、复制； Access Key 用于验证申请获取 Access Token 的请求的真实性。开发者可根据 Access Key 来获取 Access Token，Token 有效期为 2 小时，前 1.5 小时内若多次请求获取，将返回同一 Token；当有效期小于 30 分钟时，如再次请求获取，会返回新的 Token，同时旧的 Token 依然有效。详细获取 Access Token 及触发流程的步骤详见「Webhook 触发 - 通过 Access Key 获取 Token」
若选择了 Bearer Token 鉴权方式，会显示「Bearer Token」	系统自动生成，无需配置，支持编辑、复制；请求方触发流程时需携带 Bearer Token。该 Token 永久有效，请妥善保管以防泄露。详细触发流程的步骤详见「Webhook 触发 - 鉴权方式为 Bearer Token 时」
IP 白名单	配置可访问此 HTTP 连接的 IP 地址, 多个地址间使用英文分号分隔。如不配置，表示对 IP 地址不做限制。如有多个地址，请用英文分号分隔，如：127.0.0.1;127.0.0.2

HTTP

250px|700px|reset

连接配置信息配置项说明：

配置项	说明
鉴权方式	选择服务端系统需要的身份认证方式，可选项有：Basic Auth 和 Header Auth
若选择了 Query Auth 鉴权方式，会显示「Param Key」和「Param Value」	服务端系统要求请求时传入的 Key 和 Value。将添加到 HTTP 请求的 Query 中一同发送。
若选择了 No Auth 鉴权方式	不需要任何其他配置信息，运行时将不携带任何鉴权信息
若选择了飞书 Tenant Token 鉴权方式，会显示「飞书 appId」和「飞书appSecret」	请求飞书开放平台的 API 接口时，可以使用该鉴权方式，仅需要填入飞书开放平台自建应用的 App ID 和 App secret，运行时将自动获取该飞书应用的 tenant_access_token ，并将该 token 按照飞书开放平台的接口要求添加至 header 中一同发送
若选择了 Basic Auth 鉴权方式，会显示「用户名」和「密码」	请求的目的端服务接受 HTTP Basic Auth 类型鉴权时选用，具体效果： HTTP连接器选择 Basic Auth 类型连接配置后，会将填写的用户名和密码字段通过标准 Basic access 格式编码后置于发送的 HTTP 请求中名为 "Authorization" 的 Header field 内。
若选择了 Header Auth 鉴权方式，会显示「Key」和「Value」	服务端系统要求请求时传入的 Key 和 Value。将添加到 HTTP 请求的 Header 中一同发送。

备注说明：如果希望通过 HTTP 连接器请求字节跳动内网地址，需要填写：白名单申请表，申请白名单并审批通过后才能使用

RocketMQ

仅字节跳动租户可用

250px|700px|reset

配置项	说明
名称	连接配置名称
API 名称	应用内连接配置的唯一标识，自动生成，可编辑。合理设置 API 名称能让代码更易维护。
鉴权方式	选择 RocketMQ 触发时身份认证的鉴权方式，目前可选项：PSM PSM 鉴权方式仅支持字节租户使用
主题（Topic）	RocketMQ 的 Topic，引用连接配置后可以使用该 Topic 完成数据生产/消费
集群名称	RocketMQ 的 Cluster 信息

RocketMQ 连接配置，在应用通过 RocketMQ 连接器。目前 RocketMQ 连接配置和连接器均在灰度中，如需体验，请按如下步骤操作：

第一步：Topic 给平台授权

在创建 PSM 鉴权方式的 RocketMQ 连接配置之前，需要在字节云 RocketMQ 的相应 Topic 给本平台授权（本平台服务的 PSM 为：ee.kunlun.connector_service），授权界面在 IAM 平台（点击可跳转进入），通过下面的授权工单创建申请单，等待 Topic 管理员审批通过：

250px|700px|reset

第二步：添加连接器和连接配置的可见性白名单

填写：飞书低代码平台 - 连接器/连接配置白名单，此处需提供：租户 ID、应用包 Namespace 、主题（Topic）和集群（Cluster）等信息

MySQL

250px|700px|reset

250px|700px|reset

连接信息配置项说明：

配置项	说明
鉴权方式	选择服务端系统需要的身份认证方式，可选项有：PSM 和 Host：Port ；PSM 为字节内部专用的鉴权方式，外部租户不显示
若选择「PSM 鉴权方式」	PSM 鉴权方式仅支持字节租户使用会显示「本服务 PSM 」和「目标 PSM」配置项，下面详细介绍各个配置项
本服务 PSM	当前服务的唯一标识，只读，无需配置在提交创建连接配置之前，需要先让目标服务 PSM 给本服务的 PSM 授权，具体操作步骤详见「PSM 授权介绍」
目标服务 PSM	待连接的服务 PSM 标识，格式为 Product.Subsystem.Module（无 _read 或 _write 后缀），提交时会校验所填 PSM 是否存在以及是否拥有对已填 PSM 拥有读或写的权限
若选择了 Host：Port 鉴权方式	会显示「数据库地址」、「端口」、「数据库名称」、「用户名」和「密码」配置项，下面详细介绍各个配置项
数据库地址	MySQL 数据库的 Host，例如：127.0.0.1
端口	MySQL 服务器正在侦听的 TCP/IP 端口，默认为 3306 仅支持输入 0-65535 之间的整数
数据库名称	MySQL 数据库的名称
用户名	MySQL 数据库对应的用户名
密码	与 MySQL 数据库用户名匹配的密码

MySQL 连接配置在应用内使用的场景为外部对象。使用 PSM 鉴权时，请按如下步骤操作：

第一步：若使用的是 PSM 鉴权，需要申请 PSM 授权

进入 rds 平台，打开需要授权的数据库，选择新增授权 PSM

给你的数据库增加飞书低代码平台相关服务的 PSM 授权（这样飞书低代码平台才有权限访问你的数据库）：在下图的「业务 PSM」中填入连接配置中展示的「本服务的 PSM」中的多个 PSM。

注意：使用飞书低代码平台接入公司的 DB 需要给飞书低代码平台服务增加读写权限（此处如有需求，建议都增加。避免后续影响和负担）

第二步：添加连接配置和外部对象功能的白名单

填写 PSM 白名单申请，给当前应用添加目标 PSM 的访问白名单（这样可以防止飞书低代码平台的其他应用也越权访问到你的数据库），审批通过后，即可成功创建连接配置。

后续可以在流程、页面的连接器中使用该凭证；也可以在数据的外部对象中使用，例如：帮助中心｜外部对象

Hive

仅字节跳动租户可用。如需体验，可查看：aPaaS 数据集导出到 Hive 功能手册

连接信息配置项说明：

配置项	说明
名称	连接配置名称
API 名称	应用内连接配置的唯一标识，自动生成，可编辑。合理设置 API 名称能让代码更易维护。
鉴权方式	选择身份认证的鉴权方式，目前可选项：PSM PSM 鉴权方式仅支持字节租户使用
本服务的 PSM	无需配置，自动生成，需要在创建连接配置前，使目标的数据库给该 PSM 授权，详见下文 PSM 授权说明
数据库名称	字节内部的 Hive 数据库名称
集群名称	数据库对应的集群名称，一般情况下，默认填写 default 即可如在 apaas 的 boe 环境中，一般情况下，默认填写 boe 即可

给本服务 PSM 授权的步骤：

前往 Triton 平台（点击可跳转进入），点击「申请权限」

250px|700px|reset

获权方类型选择： PSM ，获权方填写为：ee.kunlun.datafactory ，其他申请内容的填写可参考：https://site.bytedance.net/docs/4832/7122/74096/

250px|700px|reset

Hive 连接配置在应用内使用的场景为数据集。

ClickHouse

250px|700px|reset

连接信息配置项说明：

配置项	说明
部署环境	ClickHouse数据库的部署环境，例如boe, cn等
集群	ClickHouse数据库部署的集群名称，例如lark_hl, boe_public_beta等
数据库名称	ClickHouse数据库的名称
用户名/密码	使用网关方式查询ClickHouse数据库的用户名与密码
网关查询地址	使用网关方式查询数据时的域名。各个环境中具体的网关地址可以参考ClickHouse网关查询域名例如cn线上为：http://clickhouse.bytedance.net cn boe为：http://clickhouse-boe.bytedance.net
元数据查询地址	ClickHouse表元数据信息查询的域名，不同区域的域名可参考Clickhouse metadata-API

TCC

仅字节跳动租户可用

250px|700px|reset

连接信息配置项说明：

配置项	说明
名称	连接配置名称
API 名称	应用内连接配置的唯一标识，自动生成，可编辑。合理设置 API 名称能让代码更易维护。
鉴权方式	选择 TCC 连接器时身份认证的鉴权方式，目前可选项：PSM PSM 鉴权方式仅支持字节租户使用
配置空间	TCC 的配置空间，引用连接配置后可以获取该配置空间的数据。

TCC 连接配置，在应用中通过 TCC 连接器使用。请按如下步骤操作：

第一步：PSM 给平台授权

在创建 PSM 鉴权方式的 TCC 连接配置之前，需要在字节云 TCC 的相应 PSM 给本平台授权（本平台服务的 PSM 为：ee.kunlun.connector_service），授权界面在TCC平台（点击可跳转进入），通过下面的授权工单创建申请单，等待 PSM 管理员审批通过：

250px|700px|reset

第二步：添加连接器和连接配置的可见性白名单

填写：飞书低代码平台 - 连接器/连接配置白名单，此处需提供：租户 ID、应用命名空间 ID（Namespace）、PSM 和配置空间等信息。

以上就是各类连接服务连接配置的配置

各类集成凭证的配置说明|飞书低代码平台

先进团队，先用飞书