跳至内容

HTTP请求凭证#

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

先决条件#

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

如需通过SSL证书确保认证安全,请参阅提供SSL证书获取所需信息。

支持的认证方法#

  • 预定义的凭证类型
  • 基础认证(通用凭证类型)
  • 自定义认证(通用凭证类型)
  • 摘要认证(通用凭证类型)
  • 头部认证(通用凭证类型)
  • Bearer认证(通用凭证类型)
  • OAuth1(通用凭证类型)
  • OAuth2(通用凭证类型)
  • 查询认证(通用凭证类型)

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

预定义的凭证类型

n8n建议在您想要连接的服务有可用凭证类型时,优先使用预定义的凭证类型。相比配置通用凭证,这种方式能提供更简便的设置和管理凭证的途径。

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

使用预定义的凭证类型#

使用预定义的凭证类型:

  1. 打开您的HTTP请求节点,或在工作流中添加一个新节点。
  2. 认证中,选择预定义凭证类型
  3. 凭证类型中,选择您想要使用的API。
  4. In Credential for <API name>, you can:
    1. 如果该平台有现有凭证,请选择它。
    2. 选择创建新凭证来新建一个凭证。

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

使用基础认证#

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

要配置此凭证,请输入:

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

使用摘要认证#

如果您的应用或服务支持摘要认证,请使用此通用认证方式。

要配置此凭证,请输入:

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

使用头部认证#

如果您的应用或服务支持头部认证,请使用此通用认证方式。

要配置此凭证,请输入:

  • 你需要将Name头部传递给HTTP请求所针对的应用程序或服务
  • 标头的

了解更多关于HTTP headers的信息

使用Bearer认证#

如果您的应用或服务支持Bearer认证,可以使用这种通用认证方式。该认证类型实际上只是将头部认证的Name设为Authorization,并将Value设为Bearer

要配置此凭证,请输入:

  • 你需要传递给HTTP请求目标应用或服务的Bearer Token

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

使用OAuth1认证#

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

要配置此凭证,请输入:

  • 一个授权URL:也称为资源所有者授权URI。该URL通常以/oauth1/authorize结尾。临时凭证会被发送到这里,以提示用户完成授权。
  • 一个访问令牌URL:这是用于初始请求临时凭证的URI。该URL通常以/oauth1/request/oauth1/token结尾。
  • 一个消费者密钥:也称为客户端密钥,类似于用户名。它指定了用于调用的oauth_consumer_key
  • 一个Consumer Secret:也称为客户端密钥,类似于密码。
  • 一个请求令牌URL:这是用于在授权后将临时凭证转换为长期凭证的URI。该URL通常以/oauth1/access结尾。
  • Select the Signature Method the auth handshake uses. This specifies the oauth_signature_method to use for the call. Options include:
    • HMAC-SHA1
    • HMAC-SHA256
    • HMAC-SHA512

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

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

使用OAuth2认证#

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

配置此凭证的要求取决于所选的授权类型。有关每种授权类型的更多信息,请参阅OAuth授权类型

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

了解更多关于OAuth2的信息。

授权码授权类型#

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

要配置此凭证,请选择授权码作为授权类型

然后输入:

  • 一个授权URL
  • 一个访问令牌URL
  • 一个客户端ID:用于登录的ID或用户名。
  • 一个客户端密钥:用于登录的密钥或密码。
  • 可选: 输入一个或多个凭证的作用域。如果未指定,该凭证将请求客户端可用的所有作用域。
  • 可选: 某些服务需要更多查询参数。如果您的服务有此需求,请将它们添加为认证URI查询参数
  • An Authentication type: Select the option that best suits your use case. Options include:
    • Header: 将凭据作为基本认证头信息发送。
    • Body: 在请求体中发送凭据。
  • 可选: 选择是否忽略SSL问题。如果开启,n8n将在SSL验证失败时仍然保持连接。

客户端凭证授权类型#

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

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

然后输入:

  • 一个访问令牌URL:用于启动OAuth2流程的URL。通常该URL以/token结尾。
  • 一个客户端ID:用于登录客户端的ID或用户名。
  • 一个客户端密钥:用于登录客户端的密钥或密码。
  • 可选: 输入一个或多个作用域用于凭证。大多数服务不支持客户端凭据授权类型的作用域;仅当您的服务支持时才在此处输入作用域。
  • An Authentication type: Select the option that best suits your use case. Options include:
    • Header: 将凭据作为基本认证头信息发送。
    • Body: 在请求体中发送凭据。
  • 可选: 选择是否忽略SSL问题。如果开启,n8n将在SSL验证失败时仍然建立连接。

PKCE授权类型#

代码交换证明密钥(PKCE)授权类型是对授权码流程的扩展,用于防止CSRF和授权码注入攻击。

要配置此凭证,请选择PKCE作为授权类型

然后输入:

  • 一个授权URL
  • 一个访问令牌URL
  • 一个客户端ID:用于登录的ID或用户名。
  • 一个客户端密钥:用于登录的密钥或密码。
  • 可选: 输入一个或多个凭证的作用域。如果未指定,该凭证将请求客户端可用的所有作用域。
  • 可选: 某些服务需要更多查询参数。如果您的服务有此需求,请将它们添加为认证URI查询参数
  • An Authentication type: Select the option that best suits your use case. Options include:
    • Header: 将凭据作为基本认证头信息发送。
    • Body: 在请求体中发送凭据。
  • 可选: 选择是否忽略SSL问题。如果开启,n8n将在SSL验证失败时仍然保持连接。

使用查询认证#

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

要配置此凭证,请输入:

  • 查询参数键或名称
  • 一个查询参数

使用自定义认证#

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

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

发送两个请求头#

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请求节点的设置中,开启SSL证书
  2. 参数选项卡中,将现有SSL证书凭证添加到SSL证书凭证或创建新凭证。

要配置您的SSL证书凭证,您需要添加:

  • 证书颁发机构 CA
  • 证书 (CRT):也可能显示为公钥,具体取决于您的证书颁发机构(CA)以及他们如何格式化证书
  • 私钥 (KEY)
  • 可选: 如果私钥已加密,请输入私钥的密码短语

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

  • 将公钥/CRT作为证书输入
  • 在该字段中输入私钥/KEY
优云智算