Skip to main content

Authorization

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

ConfigCat

Prerequisites​

The ConfigCat connector authenticates to the ConfigCat Public Management API using HTTP Basic Authentication. Before creating a credential in Nexla, generate a set of Public API credentials from the ConfigCat Dashboard.

Important

The ConfigCat Public Management API is used to manage your ConfigCat configuration—organizations, products, configs, environments, feature flags, and similar resources. It is not intended for evaluating feature flag values in your applications. For flag evaluation, use a ConfigCat SDK or the ConfigCat Proxy instead.

Generate Public API Credentials​

ConfigCat issues a Basic auth username and password pair that is used to authenticate every API request. These credentials are tied to your user account and inherit your permissions across the organizations you belong to.

  1. Sign in to the ConfigCat Dashboard.

  2. Open the Public API credentials management page (available under your account menu).

  3. Click Add New Credentials, enter a descriptive name (for example, "Nexla Integration"), and click Generate.

  4. Copy both the generated Basic auth username and Basic auth password, and store them securely.

    danger

    ConfigCat does not store your password. Once you close the credential dialog, the password cannot be retrieved again. If it is lost, you must generate a new set of credentials. Keep these values secure, and do not embed them directly in source code or share them.

For complete details about the ConfigCat Public Management API, see the ConfigCat Public Management API documentation.

Create a ConfigCat Credential​

  • To create a new ConfigCat credential, after selecting the data source/destination 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.

Authentication Settings​

ConfigCat uses HTTP Basic Authentication, in which the Public API username and password you generated above are sent with each API request. Enter the credential values generated from the ConfigCat Dashboard in the fields described below.

  1. Enter your ConfigCat Public API Basic auth username in the Username Or API Key field. This value identifies the API credential used to authenticate Nexla with ConfigCat.

  2. Enter your ConfigCat Public API Basic auth password in the Password field. This value is stored securely and is used together with the username to authenticate each request.

  3. Enter the ConfigCat API base URL in the Base URL field. This is the root endpoint that all API calls are made against, and it defaults to https://api.configcat.com/v1.

    The default base URL of https://api.configcat.com/v1 is correct for the standard ConfigCat cloud service. Update this value only if you have been directed to use a different endpoint.

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.