ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontÃÛ¶¹ÊÓƵ Workfront Fusion

HTTP > Make an API Key Authorization request

Last update: Tue Feb 11 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

This ÃÛ¶¹ÊÓƵ Workfront Fusion action module sends an HTTPS request to a specified URL that requires an API Key Auth authorization, and processes the response.

NOTE
If you are connecting to an ÃÛ¶¹ÊÓƵ product that does not currently have a dedicated connector, we recommend using the ÃÛ¶¹ÊÓƵ Authenticator module.
For more information, see ÃÛ¶¹ÊÓƵ Authenticator module.

Access requirements

Expand to view access requirements for the functionality in this article.

You must have the following access to use the functionality in this article:

table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
ÃÛ¶¹ÊÓƵ Workfront package Any
ÃÛ¶¹ÊÓƵ Workfront license

New: Standard

Or

Current: Work or higher
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current: No Workfront Fusion license requirement.

Or

Legacy: Workfront Fusion for Work Automation and Integration
Product

New:

  • Select or Prime Workfront package: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion.
  • Ultimate Workfront package: Workfront Fusion is included.

Or

Current: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

HTTP > Make an API Key Authorization request module configuration

When you configure the HTTP > Make an API Key Authorization request module, ÃÛ¶¹ÊÓƵ Workfront Fusion displays the fields listed below. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Map toggle

Credentials

Select the key that contains your API Key authentication credentials. To add a new key, click Add and configure the following information:

  • Key name

    Enter a name for this set of API credentials.

  • Key

    Enter the API Key.

  • API Key placement

    Select whether to place the API Key in the header or in the query of the API call.

  • API Key parameter name

    Enter the name by which the API call identifies the API Key, such as "apiKey" or "X-API-Key." You can find this information in the documentation of the web service the module is connecting to.

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

Use this option to set up error handling.

For more information, see Error handling.

URL
Enter the URL you want to send a request to, such as an API endpoint, website, etc.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods.
Headers
Add the headers of the request in the form of a standard JSON object. For example, {"Content-type":"application/json"}
Query String
Enter the desired query key-value pairs.
Body type

The HTTP Body is the data bytes transmitted in an HTTP transaction message immediately following the headers if there are any to be used.

  • Raw

    The Raw body type is generally suitable for most HTTP body requests even in situations where developer documentation does not specify data to send.

    Specify a form of parsing the data in the Content type field.

    Despite the content type selected, the module enters data in any format that is stipulated or required by the developer documentation.

  • Application/x-www-form-urlencoded

    This body type is to POST data using application/x-www-form-urlencoded.

    For application/x-www-form-urlencoded, the body of the HTTP message sent to the server is essentially one query string. The keys and values are encoded in key-value pairs separated by & and with a = between the key and the value.

    For binary data, use multipart/form-data instead.

    Example:

    Example of the resulting HTTP request format:

    field1=value1&field2=value2

  • Multipart/form-data

    The Multipart/form-data is an HTTP multipart request used to send files and data. It is commonly used to upload files to the server.

    Add fields to be sent in the request. Each field must contain Key-Value pair.

    • Text

      Enter the key and value to be sent within the request body.

    • File

      Enter the key and specify the source file you want to send in the request body.

      Map the file you want to upload from the previous module (such as HTTP > Get a File or Google Drive >Download a File), or enter the file name and file data manually.

Parse response

Enable this option to automatically parse responses and convert JSON and XML responses so you don't need to use JSON > Parse JSON or XML > Parse XML modules.

Before you can use parsed JSON or XML content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules.

Timeout
Specify the request timeout in seconds (1-300). The default is 40 seconds.
Share cookies with other HTTP modules
Enable this option to share cookies from the server with all HTTP modules in your scenario.
Self-signed certificate

To add a self-signed certificate:

  1. Click Extract.

  2. Select the type of file you are extracting.

  3. Select the file that contains the or certificate.

  4. Enter the password for the file.

  5. Click Save to extract the file and return to the module setup.

Reject connections that are using unverified (self-signed) certificates
Enable this option to reject connections that are using unverified TLS certificates.
Follow redirect
Enable this option to follow the URL redirects with 3xx responses.
Follow all redirects
Enable this option to follow the URL redirects with all response codes.
Disable serialization of multiple same query string keys as arrays
By default, Workfront Fusion handles multiple values for the same URL query string parameter key as arrays. For example, www.test.com?foo=bar&foo=baz will be converted to www.test.com?foo[0]=bar&foo[1]=baz. Activate this option to disable this feature.
Request compressed content

Enable this option to request a compressed version of the website.

Adds an Accept-Encoding header to request compressed content.

Use Mutual TLS

Enable this option to use Mutual TLS in the HTTP request.

For more information on Mutual TLS, see Use Mutual TLS in HTTP modules in ÃÛ¶¹ÊÓƵ Workfront Fusion.

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