Skip to main content

Authorization

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

Clickwise

Prerequisites​

Before creating a Clickwise credential, you need to obtain an API key and base URL from your Clickwise account. The API key is required to authenticate with the Clickwise API, and the base URL specifies your Clickwise API account endpoint.

To obtain your API credentials, you need to have a Clickwise account with API access enabled. Once you have access to your account, you can generate an API key from your account settings. The API key is sent in the X-ApiKey header to authenticate all API requests to the Clickwise API. The base URL is specific to your Clickwise API account and should be provided by your Clickwise account administrator or found in your account settings. For detailed information about API key setup and authentication, refer to the Clickwise API documentation.

Create a Clickwise Credential​

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

New Credential Overlay – Clickwise

ClickwiseCred.png

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.

API Key Authentication​

  1. Enter your Clickwise base URL in the Base URL field. This is the base URL for your Clickwise API account. The base URL should be provided by your Clickwise account administrator or found in your account settings. The base URL is used to construct the complete API endpoint URLs for all API requests.

  2. Enter your Clickwise API key in the API Key Value field. This is the API key you obtained from your Clickwise account settings. The API key is sent in the X-ApiKey header to authenticate all API requests to the Clickwise API.

    Keep your API key and base URL secure and do not share them publicly. The credentials provide access to your Clickwise account and should be treated as sensitive information. The API key is sent in the X-ApiKey header for all API requests to the Clickwise API. The base URL is specific to your Clickwise API account and is used to construct all API endpoint URLs. For detailed information about obtaining and managing API keys, see the Clickwise API documentation.

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/destination creation and can be selected for use with a new data source or destination.