Skip to main content

Authorization

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

Algolia

Prerequisites​

Before creating an Algolia credential, you'll need to obtain API credentials from your Algolia dashboard. The Algolia API uses header-based authentication with an Application ID and API Key.

Algolia Account Setup​

To obtain the required API credentials for Algolia:

  1. Sign in to Algolia Dashboard: Navigate to https://www.algolia.com/ and sign in to your Algolia account. If you don't have an account, you can create one by clicking Sign up and following the registration process.

  2. Access API Keys: Once signed in, navigate to your Algolia dashboard. Click on Settings in the left sidebar, then select API Keys from the settings menu. Your Application ID and API keys are displayed in this section.

  3. Locate Application ID: Your Application ID is displayed at the top of the API Keys page. This is a unique identifier for your Algolia application and is required for all API requests. The Application ID is used in the X-Algolia-Application-Id header for API authentication.

  4. Obtain API Key: Algolia provides different types of API keys for different purposes:

    • Search-Only API Key: Use this key for read-only operations such as searching indices. This key has limited permissions and is safer for client-side applications.
    • Admin API Key: Use this key for operations that require full access, including creating indices, updating settings, and managing data. This key has full permissions and should be kept secure.

For Nexla data sources, you'll typically need the Admin API Key to perform operations like listing indices and searching. The Admin API Key provides the necessary permissions for data ingestion operations. The API key is used in the X-Algolia-API-Key header for API authentication.

  1. Copy Credentials: Copy both your Application ID and your Admin API Key. Store these securely, as you'll need them when creating the credential in Nexla.

For complete information about Algolia API authentication and managing API keys, see the Algolia Search API Documentation.

API Access Requirements​

Algolia API access requires:

  • Valid Algolia Account: You must have an active Algolia account with at least one application created
  • Application ID: A unique identifier for your Algolia application (used in the X-Algolia-Application-Id header)
  • Admin API Key: An API key with appropriate permissions for the operations you need to perform (used in the X-Algolia-API-Key header)

The Algolia API uses header-based authentication with these two headers on every request. The base URLs for API requests are https://{APPLICATION_ID}.algolia.net or https://{APPLICATION_ID}-dsn.algolia.net for high availability.

Create an Algolia Credential​

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

New Credential Overlay – Algolia

AlgoliaCred.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 to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Header-based Authentication Configuration​

  1. Application ID: Enter your Algolia Application ID in the Application ID field. This unique identifier authenticates your application with the Algolia API. You can find this value in your Algolia dashboard under Settings > API Keys.

  2. API Key: Enter your Algolia Admin API Key in the API Key field. This confidential key is used to securely authenticate your application during API requests. The Admin API Key provides full access to your Algolia application, including the ability to list indices and perform search operations.

The API Key is sensitive information that should be kept secure. Nexla will store this credential securely and use it only for API authentication purposes. For production environments, consider using the Admin API Key only when necessary, and use Search-Only API Keys for read-only operations when possible.

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.