n8n 中文文档

HTTP Request 凭据

您可以使用这些凭据来验证以下节点:

先决条件

您必须使用您想要查询的应用程序或服务所需的认证方法。

如果您需要使用 SSL 证书来保护身份验证,请参阅提供 SSL 证书 以获取所需的信息。

支持的认证方式

  • 预定义的凭证类型
  • 基本身份验证(通用凭证类型)
  • 自定义身份验证(通用凭证类型)
  • 摘要验证(通用凭证类型)
  • 标头身份验证(通用凭证类型)
  • 承载身份验证(通用凭证类型)
  • OAuth1(通用凭证类型)
  • OAuth2(通用凭证类型)
  • 查询auth(通用凭证类型)
  • Simplified Custom Auth 简化自定义认证(通用凭证类型)

参考 HTTP 认证{:target=_blank .external-link}了解有关通用凭据类型的更多信息。

提示

Predefined credential types 预定义的凭证类型

只要有可用于您要连接的服务的凭据类型,n8n 建议使用预定义的凭据类型。与配置通用凭据相比,它提供了一种更简单的方法来设置和管理凭据。

您可以使用 预定义凭证类型 对某些 API 执行自定义操作,其中 n8n 具有适用于该平台的节点。例如,n8n 有一个 Asana 节点,并支持在 HTTP 请求节点中使用您的 Asana 凭据。更多信息请参阅自定义操作。

使用预定义的凭证类型

要使用预定义的凭证类型:

  1. 打开您的 HTTP 请求或 GraphQL 节点,或向您的工作流程添加一个新节点。
  2. 在Authentication 认证中,选择Predefined Credential Type 预定义凭证类型。
  3. 在Credential Type 凭证类型中,选择您要使用的API。
  4. 在Credential for <API name> “”的凭据中,您可以:
    1. 选择该平台的现有凭证(如果有)。
    2. 选择 Create New 新建 创建新凭证。

更多信息请参考自定义API操作。

要使用预定义的凭证类型:

  1. 打开您的 HTTP 请求或 GraphQL 节点,或向您的工作流程添加一个新节点。
  2. 在Authentication 认证中,选择Predefined Credential Type 预定义凭证类型。
  3. 在Credential Type 凭证类型中,选择您要使用的API。
  4. 在Credential for <API name> “”的凭据中,您可以:
    1. 选择该平台的现有凭证(如果有)。
    2. 选择 Create New 新建 创建新凭证。

要使用预定义的凭证类型:

  1. 打开您的 HTTP 请求或 GraphQL 节点,或向您的工作流程添加一个新节点。
  2. 在Authentication 认证中,选择Predefined Credential Type 预定义凭证类型。
  3. 在Credential Type 凭证类型中,选择您要使用的API。
  4. 在Credential for <API name> “”的凭据中,您可以:
    1. 选择该平台的现有凭证(如果有)。
    2. 选择 Create New 新建 创建新凭证。

要使用预定义的凭证类型:

  1. 打开您的 HTTP 请求或 GraphQL 节点,或向您的工作流程添加一个新节点。
  2. 在Authentication 认证中,选择Predefined Credential Type 预定义凭证类型。
  3. 在Credential Type 凭证类型中,选择您要使用的API。
  4. 在Credential for <API name> “”的凭据中,您可以:
    1. 选择该平台的现有凭证(如果有)。
    2. 选择 Create New 新建 创建新凭证。

要使用预定义的凭证类型:

  1. 打开您的 HTTP 请求或 GraphQL 节点,或向您的工作流程添加一个新节点。
  2. 在Authentication 认证中,选择Predefined Credential Type 预定义凭证类型。
  3. 在Credential Type 凭证类型中,选择您要使用的API。
  4. 在Credential for <API name> “”的凭据中,您可以:
    1. 选择该平台的现有凭证(如果有)。
    2. 选择 Create New 新建 创建新凭证。

使用 OAuth1

如果您的应用程序或服务支持 OAuth1 认证,请使用此通用认证。

要配置此凭据,请输入:

  • Authorization URL 授权网址:也称为资源所有者授权 URI。此 URL 通常以 /oauth1/authorize 结尾。n8n 会将临时凭据发送到此处,以提示用户完成授权。
  • Access Token URL 访问令牌 URL:这是用于临时凭证初始请求的 URI。此 URL 通常以 /oauth1/request 或 /oauth1/token 结尾。
  • A Consumer Key 消费者钥匙:也称为客户端密钥,就像用户名一样。这指定了用于调用的 oauth_consumer_key。
  • A Consumer Secret 消费者的秘密:也称为客户端密钥,类似于密码。
  • A Request Token URL 请求令牌 URL:这是授权后用于从临时凭证切换到长期凭证的 URI。此 URL 通常以 /oauth1/access 结尾。
  • 选择身份验证握手使用的 Signature Method 签名方式。这指定了用于调用的 oauth_signature_method。选项包括:
  • HMAC-SHA1
  • HMAC-SHA256
  • HMAC-SHA512

对于大多数 OAuth1 集成,您需要配置应用程序、服务或集成来生成这些字段中大部分的值。使用 n8n 中的 OAuth Redirect URL 作为此类服务的重定向 URL 或重定向 URI。

阅读更多关于 OAuth1{:target=_blank .external-link} 和 OAuth1 授权流程{:target=_blank .external-link}的信息。

使用 OAuth2

如果您的应用程序或服务支持 OAuth2 认证,请使用此通用认证。

配置此凭据的要求取决于所选的 Grant Type 授权类型。参考 OAuth Grant Types 了解每种授权类型的更多信息。

对于大多数 OAuth2 集成,您需要配置应用程序、服务或集成。使用 n8n 中的 OAuth Redirect URL 作为此类服务的重定向 URL 或重定向 URI。

进一步了解 OAuth2。

Authorization Code 授权类型

使用 Authorization Code 授权类型将授权码交换为访问令牌。授权流程使用重定向 URL 将用户返回到客户端。然后应用程序从 URL 获取授权码并使用它来请求访问令牌。参考 Authorization Code Request 了解更多信息。

要配置此凭据,请选择 Authorization Code 作为 Grant Type 授权类型。

然后输入:

  • Authorization URL 授权网址
  • Access Token URL 访问令牌 URL
  • A Client ID 客户ID:登录时使用的 ID 或用户名。
  • A Client Secret 客户秘密:用于登录的秘密或密码。
  • 可选: 输入一个或多个 Scope 适用范围 作为凭证。如果未指定,凭证将请求客户端可用的所有范围。
  • 可选: 某些服务需要更多查询参数。如果您的服务有,请将它们添加为 Auth URI Query Parameters 身份验证 URI 查询参数。
  • Authentication 认证 类型:选择最适合您的使用案例的选项。选项包括:
  • Header 标头:将凭据作为基本身份验证标头发送。
  • Body 身体:在请求正文中发送凭据。
  • 可选: 选择是否 Ignore SSL Issues 忽略 SSL 问题。如果打开,即使 SSL 验证失败,n8n 也会连接。

Client Credentials 授权类型

当应用程序请求访问令牌来访问自己的资源(而不是代表用户)时,使用 Client Credentials 授权类型。参考 Client Credentials 了解更多信息。

要配置此凭据,请选择 Client Credentials 作为 Grant Type 授权类型。

然后输入:

  • Access Token URL 访问令牌 URL:用于开始 OAuth2 流程的 URL。通常,此 URL 以 /token 结尾。
  • A Client ID 客户ID:用于登录客户端的 ID 或用户名。
  • A Client Secret 客户秘密:用于登录客户端的秘密或密码。
  • 可选: 输入一个或多个 Scope 适用范围 作为凭证。大多数服务不支持客户端凭据授予类型的范围;仅在您的范围内输入范围。
  • Authentication 认证 类型:选择最适合您的使用案例的选项。选项包括:
  • Header 标头:将凭据作为基本身份验证标头发送。
  • Body 身体:在请求正文中发送凭据。
  • 可选: 选择是否 Ignore SSL Issues 忽略 SSL 问题。如果打开,即使 SSL 验证失败,n8n 也会连接。

PKCE 授权类型

Proof Key for Code Exchange (PKCE) 授权类型是对授权码流程的扩展,用于防止 CSRF 和授权码注入攻击。

要配置此凭据,请选择 PKCE 作为 Grant Type 授权类型。

然后输入:

  • Authorization URL 授权网址
  • Access Token URL 访问令牌 URL
  • A Client ID 客户ID:登录时使用的 ID 或用户名。
  • A Client Secret 客户秘密:用于登录的秘密或密码。
  • 可选: 输入一个或多个 Scope 适用范围 作为凭证。如果未指定,凭证将请求客户端可用的所有范围。
  • 可选: 某些服务需要更多查询参数。如果您的服务有,请将它们添加为 Auth URI Query Parameters 身份验证 URI 查询参数。
  • Authentication 认证 类型:选择最适合您的使用案例的选项。选项包括:
  • Header 标头:将凭据作为基本身份验证标头发送。
  • Body 身体:在请求正文中发送凭据。
  • 可选: 选择是否 Ignore SSL Issues 忽略 SSL 问题。如果打开,即使 SSL 验证失败,n8n 也会连接。

使用查询授权

如果您的应用程序或服务支持将认证作为单个键/值查询参数传递,请使用此通用认证。(对于多个查询参数,请使用自定义认证。)

要配置此凭据,请输入:

  • 查询参数键或Name 名称
  • 查询参数Value 价值

使用自定义认证

如果应用或服务支持以多个键值查询参数传递身份验证,或者你需要比其他通用认证选项更灵活的方式,请使用这种通用身份验证。

Custom Auth 自定义认证凭据要求使用 JSON 数据定义凭据。你可以使用 headers、qs、body 或其组合。请参考以下示例开始配置。

发送两个标头

{
    "headers": {
        "X-AUTH-USERNAME": "username",
        "X-AUTH-PASSWORD": "password"
    }
}

主体

{
     "body" : {
        "user": "username",
        "pass": "password"
    }
}

查询字符串

{
    "qs": {
        "appid": "123456",
        "apikey": "my-api-key"
    }
}

发送标头和查询字符串

{
    "headers": {
        "api-version": "202404"
    },
    "qs": {
        "apikey": "my-api-key"
    }
}

使用 Simplified Custom Auth 简化自定义认证

提示

Feature availability 功能可用性

Simplified Custom Auth 自 n8n 2.35.0 起可用。在旧版本中,请改用 Custom auth 自定义认证。

如果应用或服务要求在 headers、查询参数或请求主体中提供静态身份验证值,并且你希望将 secret 值与请求定义分开保存,请使用这种通用身份验证方式。

Simplified Custom Auth 的工作方式与 Custom auth 自定义认证类似:n8n 会将 JSON 合并到使用该凭据的每个请求中。不同之处在于,此 JSON 是包含 {{placeholder}} 标记的模板,而不是 secret 本身。凭据表单会为每个 placeholder 显示一个字段;发送请求时,n8n 会将每个标记替换为对应字段的值。

这样拆分后,n8n Assistant 可以预先为你准备设置部分。当 n8n Assistant 为没有专用 n8n 凭据的服务构建工作流时,会创建这种凭据类型:它根据服务的 API 文档准备模板、字段和测试 URL,你只需将 secret 值粘贴到表单中。它还会记录服务的 API host,使 n8n 只向调用同一服务的节点提供该凭据。

你也可以自行设置凭据。在凭据模态框中选择 Edit setup 编辑设置,然后输入:

  • Auth template 身份验证模板:n8n 会将此 JSON 合并到使用该凭据的每个请求中。你可以使用 headers、qs、body 或其组合,并在每个需要 secret 或账号专用值的位置添加 {{placeholder}} 标记。不要在模板本身中填写真实值。
  • 每个 placeholder 的 Fields 字段设置:包括 Label 标签、值是 Secret 密文(遮盖显示)还是 Plain text 纯文本、是否 Required 必填,以及可选的 Hint 提示(例如用于说明预期格式)。
  • 可选: Test URL 测试 URL:保存凭据时,n8n 会向此 GET endpoint 应用身份验证并发起调用,以检查凭据是否有效。请选择不会产生副作用、绝不会触发计费操作的 endpoint,例如账号或个人资料 endpoint。
  • 可选: Accepted status codes 接受的状态码:测试凭据时,除 2xx 响应外还视为成功的状态码。例如,对于 scope 受限但 key 有效时返回 403 的服务,可以填写 403。
  • 可选: Documentation URL 文档 URL:用于创建或复制 secret 的提供商页面。它不会显示在凭据表单中;n8n Assistant 会使用它将你引导至准确页面。

然后返回表单,为每个字段输入值。保存后,n8n 会遮盖这些值。

在 header 中发送 API key

以下模板用于发送 bearer token:

{
    "headers": {
        "Authorization": "Bearer {{api_key}}"
    }
}

凭据表单会显示一个 api_key 字段。节点发送请求时,n8n 会用该字段的值替换标记,生成 header Authorization: Bearer <your-api-key>。

如果必填字段为空,请求会报错,而不会将原样标记发送给服务。如果可选字段为空,n8n 会从请求中移除使用该字段的模板条目。

提供 SSL 证书

您可以使用您的 HTTP 请求发送 SSL 证书。创建 SSL 证书作为节点使用的单独凭据:

  1. 在 HTTP Request 节点 Settings 设置中,打开 SSL Certificates。
  2. 在 Parameters 参数选项卡上,将现有的 SSL Certificate 凭据添加到 Credential for SSL Certificates 或创建新的。

要配置 SSL Certificates 凭据,你需要添加:

  • 证书颁发机构 CA 捆绑包
  • Certificate 证书 (CRT):也可能显示为公钥,具体取决于您的颁发 CA 是谁以及他们如何格式化证书
  • Private Key 私钥 (KEY)
  • 可选: 如果 Private Key 私钥 已加密,请输入 Passphrase 密码 作为私钥。

如果 SSL 证书位于单个文件(例如 .pfx 文件)中,你需要打开该文件,复制其中的详细信息并粘贴到相应字段:

  • 输入公钥/CRT 作为 Certificate 证书
  • 在该字段中输入 Private Key 私钥/KEY
不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。