n8n 中文文档

使用 API 游乐场

该文档站点提供了一个测试调用的平台。自托管用户还可以访问作为其实例一部分托管的内置游乐场。

文档游乐场

您可以测试来自此站点的 端点参考 的 API 调用。您需要设置服务器的基础 URL 和实例名称,并添加 API 密钥。

n8n 使用 标量的 开源 API 平台来支持此功能。

警告

暴露的 API 密钥和数据

使用 Playground 时,请使用范围有限的测试 API 密钥和测试数据。来自 Playground 的所有呼叫都通过 Scalar 的代理服务器进行路由。

警告

真实数据

您可以访问您的实时数据。这对于尝试请求很有用。请注意,您可以更改或删除真实数据。

内置游乐场

提示

功能可用性

API 游乐场可用于:

  • 自托管: 所有版本

它在 n8n 云上不可用。

n8n API 在自托管版本中配有内置 Swagger UI 游乐场。这提供了交互式文档,您可以在其中尝试请求。访问游乐场的路径取决于您的主机。

n8n 根据环境变量中设置的值构造路径:

N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-version-number>/docs

API 版本号为 1。未来可能会有多个版本可用。

警告

真实数据

如果您选择 授权 并在 API 游乐场中输入您的 API 密钥,您就可以访问您的实时数据。这对于尝试请求很有用。请注意,您可以更改或删除真实数据。

API 包含有关凭证格式的内置文档。这可以使用 credentials 端点来实现:

N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-version-number>/credentials/schema/{credentialTypeName}

提示

如何找到credentialTypeName

要查找类型,请将工作流程下载为 JSON 并检查它。例如,对于 Google 驱动器节点,{credentialTypeName} 为 googleDriveOAuth2Api:

{
    ...,
    "credentials": {
        "googleDriveOAuth2Api": {
        "id": "9",
        "name": "Google Drive"
        }
    }
}

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。