Connect Styla with Algolia Search

Styla uses Algolia as a search engine to let shoppers find products, categories and content you created in Styla.

Styla also uses Algolia to make filtering and sorting work on Category pages.

For those features to work, you need to have an account with Algolia.

You can either add [e-mail] as a user to your Algolia account and let your Styla contact know (and then we do the setup for you), or you can follow the below step-by-step instructions below.

First, set up Algolia:

1. Create a new account with Algolia here (or use an existing one you already have)

2. In Algolia, create a new search index that Styla should use.
   1. Follow these instructions in the Algolia help centre for more information.
   2. Name your index without spaces and ideally similar to your business or website name
3. Note down the index name you chose, you will need it later.
   

4. Set up Attributes for Faceting:

   1. Select your index (the one that will be used by Styla) and go to the Configuration tab

   2. Select Filtering and Faceting → Facets

   3. In "Attributes for faceting" add entity_type

   4. Leave the dropdown to "not searchable"

   5. Review and Save

5. Set up Deduplication and Grouping:

   1. Select your index (the one that will be used by Styla) and go to the Configuration tab

   2. Select Search Behavior → Deduplication and Grouping

   3. Set "Distinct" to false (should be already by default). NOTE: this doesn't affect our functionality, but it's recommended when using the search from the Algolia UI

   4. In "Attribute" for distinct select entity_type

   5. Review and Save:
      

Second, Share Algolia API Key details with Styla

We will need:

• • 1. The name of index you just created in the steps above
    2. The application ID - Identifier of the application.
    3. The Search API Key - the API Key used by the frontend for read-only access to deliver search results.
    4. The Admin or Write API Key - the API Key used by our backend for writing the searchable data.
       • This key will not be exposed in any of our publicly accessible services. 

You can find this information as follows:

1. Login to Algolia, if you aren't already
2. Go to your Overview -> API Keys. (Or Settings -> API Keys)
3. Copy and paste into an email the values for
   1. Application ID
   2. Search API Key
   3. Write/Admin API Key
   4. 
4. Write the name of the index you used in the first part into the email
5. Send the email to your contact at Styla.

Third, Styla will configure your account with the above information

1. We will connect your Styla storefront to your Algolia account
   
   1. The indexes will then fill with product, category and page data
2. We will create the search results page
3. We will add the search bar element into your header
4. We will contact you, once the search is configured

As soon as we got back to you, you would have to fill in the values, which you want to be filtered/found in the search. 

Fourth, you have to add searchable attributes: 

1. Select your index (the one that will be used by Styla) and go to the Configuration tab
2. Select Relevance Essentials → Searchable attributes
3. Add the searchable attributes (for e.g. (page)title, path, description...)
4. Review and Save:
   

Done

Once the above are configured, Styla automatically pushes any content updates relevant for search results to Algolia via its API. This happens for:

1. 1. Products

   2. Categories

   3. Content pages created in the Styla editor.

Algolia indexes this content and returns search results to Styla via the API. Updates triggered by BigCommerce or Styla Editor should be visible on your search results with a short delay