Skip to content

使用 API 交互式界面#

功能可用性

API 交互式界面在云版本中不可用。所有自托管定价层级均可使用此功能。

n8n API 在自托管版本中内置了 Swagger UI 交互式界面。这提供了可交互的文档，您可以在此尝试发送请求。访问路径取决于您的托管方式。

n8n 根据环境变量设置的值构建访问路径：

1
N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-版本号>/docs

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

真实数据

如果您在 API 交互式界面中选择 Authorize 并输入 API 密钥，您将获得对实时数据的访问权限。这对测试请求很有用。请注意您可能会修改或删除真实数据。

API 内置了关于凭证格式的文档。可通过 credentials 端点访问：

1
N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-版本号>/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"
        }
    }
}