Skip to content

HTTP Request 凭据#

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

先决条件#

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

如果您需要使用 SSL 证书保护认证,请参考提供 SSL 证书了解您需要的信息。

支持的认证方法#

  • Predefined credential type
  • Basic auth(通用凭据类型)
  • Custom auth(通用凭据类型)
  • Digest auth(通用凭据类型)
  • Header auth(通用凭据类型)
  • Bearer auth(通用凭据类型)
  • OAuth1(通用凭据类型)
  • OAuth2(通用凭据类型)
  • Query auth(通用凭据类型)

参考 HTTP 认证了解有关通用凭据类型的更多信息。

预定义凭据类型

当有适用于您想要连接的服务的凭据类型时,n8n 推荐使用预定义凭据类型。与配置通用凭据相比,它提供了更简单的设置和管理凭据的方式。

您可以使用预定义凭据类型对一些 n8n 有节点的平台执行自定义操作。例如,n8n 有一个 Asana 节点,并支持在 HTTP Request 节点中使用您的 Asana 凭据。参考自定义操作了解更多信息。

使用预定义凭据类型#

使用预定义凭据类型:

  1. 打开您的 HTTP 请求节点,或向工作流添加新节点。
  2. 身份验证中,选择预定义凭据类型
  3. 凭据类型中,选择您要使用的 API。
  4. <API 名称> 的凭据中,您可以:
    1. 选择该平台的现有凭据(如果可用)。
    2. 选择创建新凭据来创建新凭据。

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

使用基本身份验证#

如果您的应用或服务支持基本身份验证,请使用此通用身份验证。

要配置此凭据,请输入:

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

使用摘要身份验证#

如果您的应用或服务支持摘要身份验证,请使用此通用身份验证。

要配置此凭据,请输入:

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

使用标头身份验证#

如果您的应用或服务支持标头身份验证,请使用此通用身份验证。

要配置此凭据,请输入:

  • 您需要传递给 HTTP 请求目标应用或服务的标头名称
  • 标头的

了解更多关于 HTTP 标头的信息

使用承载身份验证#

如果您的应用或服务支持承载身份验证,请使用此通用身份验证。此身份验证类型实际上就是将 Name 设置为 Authorization、将 Value 设置为 Bearer <token> 的标头身份验证。

要配置此凭据,请输入:

  • 您需要传递给 HTTP 请求目标应用或服务的承载令牌

了解更多关于承载身份验证的信息。

使用 OAuth1#

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

要配置此凭据,请输入:

  • 一个 Authorization URL:也称为资源所有者授权 URI。此 URL 通常以 /oauth1/authorize 结尾。临时凭据被发送到这里以提示用户完成授权。
  • 一个 Access Token URL:这是用于初始请求临时凭据的 URI。此 URL 通常以 /oauth1/request/oauth1/token 结尾。
  • 一个 Consumer Key:也称为客户端密钥,类似于用户名。这指定了调用时使用的 oauth_consumer_key
  • 一个 Consumer Secret:也称为客户端密钥,类似于密码。
  • 一个 Request Token URL:这是在授权后用于从临时凭据切换到长期凭据的 URI。此 URL 通常以 /oauth1/access 结尾。
  • 选择授权握手使用的 Signature Method 签名方法。这指定了调用时使用的 oauth_signature_method。选项包括:
    • HMAC-SHA1
    • HMAC-SHA256
    • HMAC-SHA512

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

阅读更多关于 OAuth1OAuth1 授权流程的信息。

使用 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
  • 一个 Client ID 客户端 ID:用于登录的 ID 或用户名。
  • 一个 Client Secret 客户端密钥:用于登录的密钥或密码。
  • 可选: 为凭据输入一个或多个 Scope。如果未指定,凭据将请求客户端可用的所有范围。
  • 可选: 一些服务需要更多查询参数。如果您的服务需要,请将它们添加为 Auth URI Query Parameters
  • 一个 Authentication 认证类型:选择最适合您用例的选项。选项包括:
    • Header:将凭据作为基本认证标头发送。
    • Body:在请求正文中发送凭据。
  • 可选: 选择是否 Ignore SSL Issues 忽略 SSL 问题。如果打开,即使 SSL 验证失败,n8n 也会连接。

Client Credentials 授权类型#

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

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

然后输入:

  • 一个 Access Token URL:开始 OAuth2 流程的 URL。通常此 URL 以 /token 结尾。
  • 一个 Client ID 客户端 ID:用于登录客户端的 ID 或用户名。
  • 一个 Client Secret 客户端密钥:用于登录客户端的密钥或密码。
  • 可选: 为凭据输入一个或多个 Scope。大多数服务不支持 Client Credentials 授权类型的范围;只有在您的服务支持时才在此处输入范围。
  • 一个 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
  • 一个 Client ID 客户端 ID:用于登录的 ID 或用户名。
  • 一个 Client Secret 客户端密钥:用于登录的密钥或密码。
  • 可选: 为凭据输入一个或多个 Scope。如果未指定,凭据将请求客户端可用的所有范围。
  • 可选: 一些服务需要更多查询参数。如果您的服务需要,请将它们添加为 Auth URI Query Parameters
  • 一个 Authentication 认证类型:选择最适合您用例的选项。选项包括:
    • Header:将凭据作为基本认证标头发送。
    • Body:在请求正文中发送凭据。
  • 可选: 选择是否 Ignore SSL Issues 忽略 SSL 问题。如果打开,即使 SSL 验证失败,n8n 也会连接。

使用查询认证#

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

要配置此凭据,请输入:

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

使用自定义认证#

如果您的应用程序或服务支持将认证作为多个键/值查询参数传递,或者您需要比其他通用认证选项更多的灵活性,请使用此通用认证。

Custom Auth 自定义认证凭据需要 JSON 数据来定义您的凭据。您可以使用 headersqsbody 或混合使用。查看下面的示例开始使用。

发送两个标头#

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

Body#

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 参数选项卡上,将现有的 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