使用API演练场#

本文档站点提供了一个用于测试调用的演练场。自托管用户也可访问作为其实例组成部分的内置演练场。

文档演练场#

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

n8n使用Scalar开源API平台驱动此功能。

暴露的API密钥与数据
使用演练场时，请采用权限范围受限的测试API密钥及测试数据。所有演练场调用均会经过Scalar代理服务器。

真实数据
您可访问实时数据，这对调试请求非常有用。请注意您可能修改或删除真实数据。

内置演练场#

功能可用性
API演练场在云端版本不可用，适用于所有自托管定价层级。

n8n API在自托管版本中内置了Swagger UI演练场，提供可实时调试请求的交互式文档。访问路径取决于您的托管方式。

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

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"
        }
    }
}