使用 API 沙盒环境#

本网站提供了一个沙盒环境（playground），可用于测试 API 调用。自托管用户也可以通过其部署实例访问内置的沙盒环境。

文档沙盒环境#

你可以从本站在 API 参考文档 中直接测试 API 请求。你需要设置服务器的基础 URL、实例名称，并添加一个 API 密钥。

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

暴露的 API 密钥和数据 在使用沙盒环境时，请使用作用范围受限的测试用 API 密钥和测试数据。所有来自沙盒环境的请求都会经过 Scalar 的代理服务器进行转发。

真实数据 你将能够访问自己的实时数据。这对于尝试请求非常有用，但请注意：你可能会意外修改或删除真实数据。

内置沙盒环境#

功能可用性 API 沙盒环境在 n8n Cloud 版本中不可用，仅适用于所有自托管（self-hosted）版本的不同定价层级。

n8n 的 API 在自托管版本中集成了内置的 Swagger UI 沙盒环境。该环境提供交互式文档，允许你直接尝试各种请求。访问路径取决于你的部署方式。

n8n 会根据你在环境变量中设置的值自动构建访问路径：

1

| ``` N8N_HOST:N8N_PORT/N8N_PATH/api/v/docs

---|---
API 版本号目前为 `1`。未来可能会有多个版本可用。

**真实数据**
如果你在 API 沙盒环境中点击 **Authorize**（授权）并输入了你的 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" } } }

---|---