API key authentication type

2 min

API key authentication type is used when the service provider requires an API key.

Create a keychain for the API key authentication type

Field	Description
Name	Enter the name for your API key connection.
Key	Enter the full API key, including any required prefix if specified in the API documentation. For example, Bearer, Token, or APIKey Example: Bearer 1234-5678-abcd-efgh
API key placement	Select where the API key should be added: in the request header or in the query parameters. Most modern APIs require the API key to be included in the header. However, to confirm, you need to check the API documentation for each service.
API key parameter name	Enter the name of the parameter that contains the API key. For example, authorization, x-api-key, or api_key. This is how the service will identify the API key in your HTTP request.

You can edit these credentials at any moment in the Keys section. For that:

Click Keys (or three dots > Keys) in the left sidebar.

Click three dots > Edit next to the required Key.

You will see the Edit key window. Add new credentials and click Save. All the modules that use this keychain will be automatically adjusted.

This example shows how to configure the HTTP > Make a request module for a GET request to Coda to retrieve a list of available docs.

To make an HTTP request, you need to know the required authentication details, scopes, endpoints, and parameters for each request. Refer to the Coda API documentation for these details.

In the Authentication type field, select API key.

Click Credentials (or Add next to Choose a key) to add your API key:

In the Name field, enter a name for your API key.

In the Key field, enter the API key (called API token in Coda) you've obtained from your Coda account.

Since Coda requires specifying its API token by setting a header as Authorization: Bearer <api_token>, add the token to the Key field in this format: Bearer <api_token>.

In the API Key placement field, select In the header as required by the Coda API Documentation.

In the API Key parameters name field, enter Authorization.

Click Create.

You can also click Choose a key to use an existing keychain from the drop-down list.

In the URL field, add the required API call. To list available docs in Coda, this example will use this URL: https://coda.io/apis/v1/docs

Select the GET method required for this API call.

Leave the Headers section empty.

In the Query section, you can add query for the Name field, and invoice for the Value field. This way, you will set the filter to retrieve the docs that contain 'invoice' in their name. You can also set any other query.

You can find the mandatory and optional query parameters in the service's API documentation.

Since it's a GET request, you can leave the Body content section empty.

Click Save and run the module.

You'll see the HTTP response in the output bundle:

To make an HTTP POST request to create a doc:

Use the same credentials and the same URL: https://coda.io/apis/v1/docs

Select the POST method required for this API call.

Leave the Headers and Query sections empty.

For the Body section:

In the Body content type field, select application/json.

In the Body input method field, select Data structure.

In the Body structure field, click Add to create a new data structure. Add a text field title to be able to name the newly created doc, and a text field folderId to indicate the ID of the folder where the doc should be created. Click Save.

In the Body content field, add the Title and the Folder ID.

Click Save and run the module.

You can now check your Coda app. A new document called New Doc from Make will be created. You can also see it in the output:

API key authentication type

Create a keychain for the API key authentication type

HTTP request example with API key authentication