Skip to main content

Add Uniform integration

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 the Integrations tab.

  3. Scroll to the section Browse Integrations.

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

    algolia-v2-add-integration
  5. Enter your Application ID and API Key and click Test.

    algolia-v2-test-integration
  6. Once Uniform successfully connects to Algolia, you will select which index(es) you would like to connect to this project.

  7. Complete the integration by clicking the red Save button.