HTTP > Make an API Key Authorization request

此Adobe Workfront Fusion操作模块向需要API密钥身份验证授权的指定URL发送HTTPS请求,并处理响应。

NOTE
如果您要连接到当前没有专用连接器的Adobe产品,我们建议您使用Adobe Authenticator模块。
有关详细信息,请参阅Adobe Authenticator模块

访问要求

展开以查看本文中各项功能的访问要求。

您必须具有以下权限才能使用本文中的功能:

table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
Adobe Workfront包 任何
Adobe Workfront许可证

新增:标准

当前:工作或更高

Adobe Workfront Fusion许可证**

当前:无Workfront Fusion许可证要求。

旧版:Workfront Fusion for Work Automation and Integration

产品

新增:

  • 选择或Prime Workfront包:您的组织必须购买Adobe Workfront Fusion。
  • Ultimate Workfront包:其中包含Workfront Fusion。

当前:您的组织必须购买Adobe Workfront Fusion。

有关此表中信息的更多详细信息,请参阅文档🔗中的访问要求。

有关Adobe Workfront Fusion许可证的信息,请参阅Adobe Workfront Fusion 许可证

HTTP > Make an API Key Authorization request模块配置

配置HTTP > Make an API Key Authorization request模块时,Adobe Workfront Fusion显示下面列出的字段。 模块中的粗体标题表示必填字段。

如果看到字段或函数上方的映射按钮,则可以使用该按钮设置该字段的变量和函数。 有关详细信息,请参阅在 Adobe Workfront Fusion中将信息从一个模块映射到另一个模块。

映射切换

Credentials

选择包含API密钥身份验证凭据的密钥。 要添加新密钥,请单击 Add 并配置以下信息:

  • Key name

    输入这组API凭据的名称。

  • Key

    输入API密钥。

  • API Key placement

    选择是将API密钥放在API调用的标头中还是查询中。

  • API Key parameter name

    输入API调用用于标识API密钥的名称,如“apiKey”或“X-API-Key”。 您可以在该模块所连接的Web服务的文档中查找此信息。

Evaluate all states as errors (except for 2xx and 3xx)

使用此选项可设置错误处理。

有关详细信息,请参阅错误处理

URL
输入要向其发送请求的URL,如API端点、网站等。
Method
选择配置API调用所需的HTTP请求方法。 有关详细信息,请参阅HTTP请求方法
Headers
以标准JSON对象的形式添加请求的标头。 例如, {"Content-type":"application/json"}
Query String
输入所需的查询键值对。
Body type

HTTP正文是在HTTP事务消息中传输的数据字节,这些字节紧跟在标头之后(如果存在任何要使用的标头)。

  • Raw

    原始正文类型通常适用于大多数HTTP正文请求,即使在开发人员文档未指定要发送的数据的情况下也是如此。

    在Content type字段中指定解析数据的形式。

    尽管选择了内容类型,模块仍会以开发人员文档规定或要求的任何格式输入数据。

  • Application/x-www-form-urlencoded

    此正文类型使用application/x-www-form-urlencoded为POST数据。

    对于application/x-www-form-urlencoded,发送到服务器的HTTP消息正文本质上是一个查询字符串。 键和值在键值对中进行编码,键值对以&分隔,在键和值之间使用=

    对于二进制数据,请改用multipart/form-data

    示例:

    生成的HTTP请求格式的示例:

    field1=value1&field2=value2

  • Multipart/form-data

    Multipart/form-data是用于发送文件和数据的HTTP多部分请求。 它通常用于将文件上传到服务器。

    添加要在请求中发送的字段。 每个字段都必须包含键值对。

    • Text

      输入要在请求正文中发送的键和值。

    • File

      输入密钥,并在请求正文中指定要发送的源文件。

      映射您要从上一个模块上传的文件(如HTTP > Get a File或Google Drive >Download a File),或手动输入文件名和文件数据。

Parse response

启用此选项可自动解析响应并转换JSON和XML响应,因此您无需使用JSON > Parse JSON或XML > Parse XML模块。

在使用解析的JSON或XML内容之前,请手动运行一次模块,以便模块能够识别响应内容并允许您在后续模块中映射该内容。

Timeout
以秒为单位指定请求超时(1-300)。 默认值为40秒。
Share cookies with other HTTP modules
启用此选项可将来自服务器的Cookie与场景中的所有HTTP模块共享。
Self-signed certificate

要添加自签名证书,请执行以下操作:

  1. 单击 Extract

  2. 选择要提取的文件类型。

  3. 选择包含或证书的文件。

  4. 输入文件的密码。

  5. 单击 Save 提取文件并返回模块设置。

Reject connections that are using unverified (self-signed) certificates
启用此选项可拒绝使用未经验证的TLS证书的连接。
Follow redirect
启用此选项可在3xx响应中遵循URL重定向。
Follow all redirects
启用此选项后,URL重定向会带有所有响应代码。
Disable serialization of multiple same query string keys as arrays
默认情况下,Workfront Fusion处理与数组相同的URL查询字符串参数键的多个值。 例如,www.test.com?foo=bar&foo=baz将转换为www.test.com?foo[0]=bar&foo[1]=baz。 激活此选项以禁用此功能。
Request compressed content

启用此选项可请求网站的压缩版本。

添加Accept-Encoding标头以请求压缩的内容。

Use Mutual TLS

启用此选项可在HTTP请求中使用双向TLS。

有关双方TLS的详细信息,请参阅在Adobe Workfront Fusion中的HTTP模块中使用双方TLS。

recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3