API 身份验证#

n8n 使用 API 密钥来验证 API 调用。

功能可用性

n8n API 在免费试用期间不可用。请升级以访问此功能。

API 作用域#

企业实例的用户可以通过作用域限制密钥可以访问的资源和操作。API 密钥作用域允许您指定密钥为其预定目的所需的确切访问级别。

非企业版 API 密钥对账户的所有资源和功能具有完全访问权限。

创建 API 密钥#

登录 n8n。
转到设置 > n8n API。
选择 创建 API 密钥。
为密钥选择一个标签并设置过期时间。
如果使用企业计划，选择给密钥的 作用域。
复制 我的 API 密钥 并使用此密钥验证您的调用。

使用您的密钥调用 API#

在 API 调用中将 API 密钥作为名为 X-N8N-API-KEY 的标头发送。

例如，假设您想要获取所有活跃的工作流。您的 curl 请求将如下所示：

# 自托管 n8n 实例
curl -X 'GET' \
  '<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

# n8n 云服务
curl -X 'GET' \
  '<your-cloud-instance>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'