Skip to content

HTTP 请求凭证#

您可以使用以下凭证验证以下节点：

前提条件#

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

如果需要通过 SSL 证书保护认证，请参阅提供 SSL 证书获取所需信息。

支持的认证方法#

  • 预定义凭证类型
  • 基本认证（通用凭证类型）
  • 自定义认证（通用凭证类型）
  • 摘要认证（通用凭证类型）
  • 头部认证（通用凭证类型）
  • Bearer 认证（通用凭证类型）
  • OAuth1（通用凭证类型）
  • OAuth2（通用凭证类型）
  • 查询认证（通用凭证类型）

有关通用凭证类型的更多信息，请参阅 HTTP 认证。

预定义凭证类型

n8n 建议在服务有可用凭证类型时优先使用预定义凭证类型。相比配置通用凭证，它提供了更简单的设置和管理方式。

您可以使用预定义凭证类型对某些 API 执行自定义操作，前提是 n8n 已为该平台提供节点。例如，n8n 有 Asana 节点，并支持在 HTTP 请求节点中使用您的 Asana 凭证。更多信息请参阅自定义操作。

使用预定义凭证类型#

要使用预定义凭据类型：

  1. 打开您的 HTTP Request 节点，或在工作流中添加一个新节点。
  2. 在 认证方式 中，选择 预定义凭据类型。
  3. 在 凭据类型 中，选择您想使用的 API。
  4. 在 <API名称> 的凭据 中，您可以：
    1. 选择该平台现有的凭据（如果有）。
    2. 选择 创建新凭据 来新建一个凭据。

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

使用基本认证(Basic Auth)#

如果您的应用程序或服务支持基本认证，可以使用这种通用认证方式。

配置此凭证时，需要输入：

  • 用户名：用于访问HTTP请求目标应用或服务的用户名
  • 密码：与该用户名对应的密码

使用摘要认证(Digest Auth)#

如果您的应用或服务支持摘要认证，可以使用这种通用认证方式。

配置此凭证时，需要输入：

  • 用户名 - 用于访问 HTTP 请求目标应用或服务的用户名
  • 密码 - 与该用户名对应的密码

如果您的应用或服务支持 Header 认证，可以使用这种通用认证方式。

配置此凭证时，需要输入：

  • HTTP 请求目标应用或服务所需的 Header 名称
  • Header 的值

了解更多关于 HTTP 头信息

使用 Bearer 认证#

如果您的应用或服务支持 bearer 认证，可以使用这种通用认证方式。这种认证类型实际上就是 header 认证，其中 Name 设置为 Authorization，Value 设置为 Bearer <token>。

配置此凭据时，需要输入： - Bearer Token：您需要传递给 HTTP 请求目标应用或服务的令牌

了解更多关于 bearer 认证的信息。

使用 OAuth1 认证#

当您的应用或服务支持 OAuth1 认证时，可以使用此通用认证方式。

配置此凭据需要填写以下信息：

  • 授权 URL：也称为资源所有者授权 URI。该 URL 通常以 /oauth1/authorize 结尾。临时凭据会发送至此 URL 以提示用户完成授权。
  • 访问令牌 URL：用于初始请求获取临时凭据的 URI。该 URL 通常以 /oauth1/request 或 /oauth1/token 结尾。
  • 消费者密钥：也称为客户端密钥，类似于用户名。指定调用时使用的 oauth_consumer_key。
  • 消费者密钥：也称为客户端密钥，类似于密码。
  • 请求令牌 URL：用于在授权后将临时凭据转换为长期凭据的 URI。该 URL 通常以 /oauth1/access 结尾。
  • 选择认证握手使用的签名方法。指定调用时使用的 oauth_signature_method。可选方法包括：
    • HMAC-SHA1
    • HMAC-SHA256
    • HMAC-SHA512

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

了解更多关于 OAuth1 和 OAuth1 授权流程 的信息。

使用 OAuth2 认证#

如果您的应用或服务支持 OAuth2 认证，可以使用这种通用认证方式。

配置此凭据的要求取决于所选的授权类型(Grant Type)。有关每种授权类型的详细信息，请参考 OAuth 授权类型。

对于大多数 OAuth2 集成，您需要配置一个应用、服务或集成。将 n8n 中的OAuth 重定向 URL 用作此类服务的重定向 URL 或重定向 URI。

了解更多关于 OAuth2 的信息。

授权码授权类型#

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

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

然后输入：

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

客户端凭证授权类型#

当应用程序请求访问令牌以访问其自身资源（而非代表用户）时，请使用客户端凭证授权类型。更多信息请参考客户端凭证。

要配置此凭证，请选择客户端凭证作为授权类型。

然后输入：

  • 访问令牌URL：发起OAuth2流程的URL地址。通常该URL以/token结尾。
  • 客户端ID：用于登录客户端的ID或用户名。
  • 客户端密钥：用于登录客户端的密钥或密码。
  • 可选：为该凭证输入一个或多个Scope（作用域）。大多数服务不支持客户端凭证授权类型的作用域；仅当您的服务支持时才在此处输入作用域。
  • 认证类型：选择最适合您用例的选项。可用选项包括：
    • Header：将凭证作为基本认证头发送。
    • Body：在请求正文中发送凭证。
  • 可选：选择是否忽略SSL问题。如果开启，即使SSL验证失败，n8n也会建立连接。

PKCE 授权类型#

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

配置此凭据时，选择 PKCE 作为 授权类型。

然后输入：

  • 授权 URL
  • 访问令牌 URL
  • 客户端 ID：用于登录的 ID 或用户名
  • 客户端密钥：用于登录的密钥或密码
  • 可选：为凭据输入一个或多个 Scope（作用域）。如果未指定，凭据将请求客户端可用的所有作用域。
  • 可选：某些服务需要更多查询参数。如果您的服务有此要求，请将其添加为 Auth URI 查询参数。
  • 认证类型：选择最适合您用例的选项。可选类型包括：
  • Header：将凭据作为基本认证头发送
  • Body：在请求正文中发送凭据
  • 可选：选择是否 忽略 SSL 问题。如果开启，即使 SSL 验证失败，n8n 也会连接

使用查询认证#

如果您的应用或服务支持通过单个键值对查询参数传递认证信息，请使用此通用认证方式。（如需多个查询参数，请使用自定义认证）

配置此凭据时，输入：

  • 查询参数的键或名称
  • 查询参数的值

使用自定义认证#

如果您的应用或服务支持通过多个键值对查询参数传递认证信息，或者您需要比其他通用认证选项更大的灵活性，请使用此通用认证方式。

自定义认证凭据需要 JSON 数据来定义您的凭据。您可以使用 headers、qs、body 或其组合。请参考以下示例开始使用。

发送两个请求头#

1
2
3
4
5
6
{
	"headers": {
		"X-AUTH-USERNAME": "username",
		"X-AUTH-PASSWORD": "password"
	}
}

请求体#

1
2
3
4
5
6
{
	 "body" : {
		"user": "username",
		"pass": "password"
	}
}

查询字符串#

1
2
3
4
5
6
{
	"qs": { 
		"appid": "123456",
		"apikey": "my-api-key"
	}
}

发送请求头和查询字符串#

1
2
3
4
5
6
7
8
{
	"headers": {
		"api-version": "202404"
	},
	"qs": {
		"apikey": "my-api-key"
	}
}

提供 SSL 证书#

您可以在 HTTP 请求中附带 SSL 证书。请将 SSL 证书创建为单独的凭证供节点使用：

  1. 在 HTTP Request 节点的 Settings 中，开启 SSL Certificates 选项。
  2. 在 Parameters 选项卡中，向 Credential for SSL Certificates 添加现有的 SSL 证书凭证或创建新凭证。

配置 SSL 证书凭证时，您需要提供：

  • 证书颁发机构 CA 包
  • Certificate (CRT)：也可能显示为公钥，具体取决于您的证书颁发机构及其证书格式
  • Private Key (KEY)
  • 可选： 如果 Private Key 已加密，请输入私钥的 Passphrase

如果您的 SSL 证书是单个文件（如 .pfx 文件），则需要打开该文件复制相关内容粘贴到相应字段：

  • 将公钥/CRT 作为 Certificate 输入
  • 将 Private Key/KEY 输入到对应字段