Configure Algolia

Last updated:
Edit on GitHub

Once you have integrated the Algolia app, you can configure it.

Prerequisites

To sign up for Algolia, contact your Customer Success Manager.

Configure Algolia

To configure Algolia, do the following:

  1. In your store’s Back Office, go to Apps.
  2. In App Composition Platform Catalog, click Algolia. This takes you to the Algolia app details page.
  3. In the top right corner of the Algolia app details page, click Connect app. The notification saying that the application connection is pending is displayed.
  4. Log in to the Algolia website.
  5. On the Algolia website, go to Settings.
  6. Under Team and Access, click API keys.

algolia-keys

  1. In the Your API Keys tab, take note of following keys:
    • Application ID
    • Search API Key
    • Admin API Key
  2. In the Back Office, go to the Algolia app details page.
  3. In the top right corner of the Algolia app details page, click Configure.
  4. In the Configure pane, for APPLICATION ID, SEARCH API KEY, and ADMIN API KEY, enter the values you’ve retrieved in step 7.

algolia-settings

  1. To enable Algolia, select Use Algolia instead of Elasticsearch. After you save the settings, this enables Algolia search on your frontends: Yves or Glue API-based application. You can also enable it later, for example–after all your products are synced with Algolia.
  2. Click Save.

The Algolia app is now added to your store and starts exporting your product data automatically.

Info

Depending on the size of your product catalog, Algolia can take from few minutes to several hours to export it. The average export speed is around 300 products per minute.

Verification

Verify that your index is populated with data from your store:

  1. Go to the Algolia website.
  2. In the side pane, go to Search > Index.
  3. Make sure that the index is populated with data from your store.

algolia-index-data

For details about the created index data, see Indexes.