Skip to main content

Authorization

Follow this guide to create a new Clari Copilot credential that will allow Nexla to authenticate to and exchange data with your Clari Copilot account.
clari_copilot_api_auth.png

Clari Copilot

Prerequisites​

To connect Nexla to Clari Copilot, you need an active Clari Copilot workspace and a workspace role with access to integration settings (typically an administrator or workspace owner). Clari Copilot authenticates API requests using two values that are sent together as request headers: an API Key (sent as the X-Api-Key header) and an API Password (sent as the X-Api-Password header).

Generate Your Clari Copilot API Key and API Password​

Clari Copilot issues a single API Key and API Password pair per workspace. Both values are required, and they are used together to authenticate every request.

  1. Sign in to your Clari Copilot account at https://copilot.clari.com.

  2. Open Workspace Settings from the workspace menu.

  3. Navigate to Integrations, and select Copilot API.

  4. Locate the API Key and API Password values displayed in this section. If no key has been generated yet, use the option provided to generate the API credentials.

  5. Copy both the API Key and API Password values for use when creating your Nexla credential.

    Store your credentials securely

    The API Password may not be retrievable again after it is first generated or viewed. Copy it immediately and store it in a secure location. If the value is lost, you must revoke and regenerate the credentials, which will invalidate the previous pair.

Clari Copilot provides one API Key and API Password pair per workspace. Regenerating the credentials invalidates the previous pair, so any other integration using the prior values will stop working until updated. For complete details, refer to the Clari Copilot API documentation.

Create a Clari Copilot Credential​

  • To create a new Clari Copilot credential, after selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Clari Copilot Authentication​

Clari Copilot uses API key authentication. The API Key and API Password are sent together as request headers (X-Api-Key and X-Api-Password) to authenticate Nexla with your workspace. Both values come from the Workspace Settings > Integrations > Copilot API section of your Clari Copilot account.

  1. Enter the API key from your Clari Copilot workspace in the API Key field. This value is sent as the X-Api-Key header and identifies your workspace to the Clari Copilot API.

  2. Enter the API password from your Clari Copilot workspace in the API Password field. This value is sent as the X-Api-Password header and is used together with the API key to authenticate each request. Keep this value secure, as it grants access to your workspace data.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source creation and can be selected for use with a new data source.