HTTP > Make an API Key Authorization request

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.

Use this option to set up error handling.

For more information, see Error handling.

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.

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.

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.

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

Adds an Accept-Encoding header to request compressed content.

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 Adobe Workfront Fusion.