跳到主要内容

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的请求头传递API密钥。

例如，如需获取所有活跃工作流，curl请求示例如下：

# 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. 选择永久删除确认操作