Skip to content

使用 API 游乐场#

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

文档游乐场#

您可以从本网站的 API 参考 测试 API 调用。您需要设置服务器的基本 URL 和实例名称，并添加 API 密钥。

n8n 使用 Scalar's 开源 API 平台来支持此功能。

暴露的 API 密钥和数据

使用游乐场时，请使用具有有限范围的测试 API 密钥和测试数据。来自游乐场的所有调用都通过 Scalar 的代理服务器路由。

真实数据

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

内置游乐场#

功能可用性

API 游乐场在云版本中不可用。它适用于所有自托管定价层。

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

n8n 从您的环境变量中设置的值构造路径：

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

API 版本号是 1。将来可能有多个版本可用。

真实数据

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

API 包含关于凭据格式的内置文档。这可以使用 credentials 端点获得：

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

如何找到 credentialTypeName

要找到类型，请将您的工作流下载为 JSON 并检查它。例如，对于 Google Drive 节点，{credentialTypeName} 是 googleDriveOAuth2Api： 

1
2
3
4
5
6
7
8
9
{
    ...,
    "credentials": {
        "googleDriveOAuth2Api": {
        "id": "9",
        "name": "Google Drive"
        }
    }
}