使用 API 测试台

文档站提供用于测试调用的 API 测试台。自托管用户还可使用随实例提供的内置测试台。

文档测试台

可在文档站的端点参考中测试 API 调用。需要设置服务器的基础 URL 和实例名称，并添加 API 密钥。

n8n 使用 Scalar 的开源 API 平台提供此功能。

注意

暴露的 API 密钥和数据

使用测试台时，请使用作用域受限的测试 API 密钥和测试数据。测试台的所有调用都会经过 Scalar 代理服务器。

注意

真实数据

你能够访问正式数据，这便于试用请求。请注意，请求可能更改或删除真实数据。

信息

功能可用范围

API 测试台可用于：

n8n Cloud 不提供此功能。

自托管版本的 n8n API 带有内置 Swagger UI 测试台，提供可尝试请求的交互式文档。访问路径取决于托管配置。

n8n 使用环境变量中设置的值构造路径：

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

API 版本号为 1，未来可能同时提供多个版本。

注意

真实数据

在 API 测试台选择 Authorize（授权）并输入 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"
        }
    }
}