API 身份验证

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

功能可用性

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

API 范围

企业实例的用户可以使用范围限制密钥可以访问的资源和操作。API 密钥范围允许您为密钥的预期用途指定确切的访问级别。

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

创建 API 密钥

1. 登录到 n8n。
2. 转到设置 > n8n API。
3. 选择创建 API 密钥。
4. 为密钥选择标签并设置过期时间。
5. 如果使用企业计划，选择要给密钥的范围。
6. 复制我的 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 Cloud
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>'

删除 API 密钥

1. 登录到 n8n。
2. 转到设置 > n8n API。
3. 在要删除的密钥旁边选择删除。
4. 通过选择永久删除确认删除。