Skip to content

API 身份验证

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

功能可用性

免费试用期间，n8n API 不可用。请升级才能使用此功能。

API 范围

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

非企业 API 密钥可以完全访问帐户的所有资源和功能。

创建 API 密钥

  1. 登录 n8n。
  2. 转到设置> n8n API 。
  3. 选择创建 API 密钥。
  4. 选择一个标签并设置密钥的到期时间。
  5. 如果是企业计划，请选择范围来提供密钥。
  6. 复制我的 API 密钥并使用此密钥来验证您的呼叫。

使用您的密钥调用 API

将 API 调用中的 API 密钥作为名为 的标头发送。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# For a self-hosted n8n instance
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>'

# For 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. 选择“永久删除”确认删除。