Algolia

Algolia empowers builders with the search and recommendation services they need to build world-class experiences.

This integration allows business users to build personalized digital experiences by repurposing content from your Algolia search platform.

About this integration

When you install the Algolia integrations, you are effectively getting multiple integrations in one:

  1. Pre-built search components that business users can assemble into powerful search capabilities.
  2. Traditional integration that exposes records from Algolia as content that can be bound to front-end components using Uniform Canvas.
  3. Classic integration that allows developers to bind data from Algolia records to components through code.

Adding the Algolia integration to your Uniform project adds data from your search index to compositions and incorporates additional components into your application. You can bypass calling your data source and pull information directly from your Algolia search index.

Before you start

You need to have the following values from Algolia to add the integration to your project:

  • Application ID

  • API key that must have the following permissions: search, listIndexes, and settings.

    Set this API key as a "Local key" in Algolia. Local keys are permanently attached to an index. The local key configuration can't be changed once set.

    algolia-index-permissions

  1. In Uniform, open your project.

  2. Navigate to Settings > Integrations.

  3. Scroll to the section Browse Integrations.

  4. Search for Algolia, find the integration and click Add to project.

    algolia-v2-add-integration

  5. A screen is displayed for you to provide connection settings for Algolia.

    About these settings

    These values are only required if you are using the Algolia components or the Algolia classic integration.

Depending on how you want to use Algolia with Uniform, you can:

TopicDescription
Algolia componentsUse the pre-built Algolia components to add search to your application.
Algolia integrationPopulate your existing components with content from an Algolia index.
Algolia classic integrationBuild your own search components using low-level components from Uniform.
Last modified
Next
Algolia components