Skip to main content

​
Overview

To authenticate with Private API (Generic), you need one key piece of information:
  1. API Key - The key that the proxy injects into your upstream API requests.
How the key is presented (header vs query param, its name, and any prefix like Bearer or Api-Key) is configured on the integration by the team that set it up, not by the end user. This guide will walk you through setting up a connection with Private API (Generic).

​
Step 1: Get your API Key

Obtain your API key from your API provider.

​
Step 2: Enter credentials in the Connect UI

Once you have your API Key:
  1. Open the form where you need to authenticate with Private API (Generic).
  2. Enter your API Key in the API key field (its label may be customized for the integration).
  3. Submit the form, and you should be successfully authenticated.
You are now connected to Private API (Generic).