使用 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 端点获取：

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

如何找到 credentialTypeName

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

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

此页面是否

💬 微信

关注公众号

n8n实战笔记
📚 教程 💡 案例 🔧 技巧

添加微信

1对1 专业指导
⚡ 快答 🎯 定制 🚀 支持

添加后请直说来意，看到会回复。谢谢