Skip to main content

Authorization

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

SimilarWeb

Prerequisites​

Before creating a SimilarWeb credential, you need to obtain your API Key from your SimilarWeb account. SimilarWeb uses API Key authentication for all API requests, with the API key sent as a URL parameter.

To obtain your SimilarWeb API Key, follow these steps:

  1. Sign in to your SimilarWeb account using your administrator credentials.

  2. Navigate to your account settings or API management section in the SimilarWeb interface.

  3. Look for the API or API Keys section in your account settings, or navigate to Settings > API or Account > API Keys.

  4. If you don't have an API key yet, look for the option to generate or create your API key.

  5. Click Create API Key or Generate API Key to create a new API key.

  6. Configure your API key settings:

    • Enter a name for the API key (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the key (if applicable)

  7. Click Create or Generate to create the API key.

  8. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  9. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent as a URL parameter (api_key) in all API requests to the SimilarWeb API. The API key authenticates your requests and grants access to SimilarWeb resources based on your account permissions. To access the full capabilities of the SimilarWeb API, you need to authenticate your requests using an API key. If your API key is compromised, you should immediately revoke it in your SimilarWeb account settings and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the SimilarWeb API documentation.

Create a SimilarWeb Credential​

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

New Credential Overlay – SimilarWeb

SimilarWebCred.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​

SimilarWeb uses API Key authentication for all API requests. The API key is sent as a URL parameter (api_key) to authenticate API requests to the SimilarWeb API.

  1. Enter your SimilarWeb API Key Value in the API Key Value field. This is the API key you obtained from your SimilarWeb account settings (Settings > API or Account > API Keys). The API key is sent as a URL parameter (api_key) for all API requests to the SimilarWeb API. To access the full capabilities of the SimilarWeb API, you need to authenticate your requests using an API key. The API key is sensitive information and must be kept confidential.

    Your SimilarWeb API key can be found in your SimilarWeb account settings under Settings > API or Account > API Keys. The API key is sent as a URL parameter (api_key) for all API requests to the SimilarWeb API. To access the full capabilities of the SimilarWeb API, you need to authenticate your requests using an API key.

    If your API key is compromised, you should immediately revoke it in your SimilarWeb account settings and generate a new one. The API key provides access to your SimilarWeb account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the SimilarWeb 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.