Skip to main content

Connect Algolia

Algolia is a hosted search service with typo tolerance, fast faceting and secured API keys for per-user access control.

Before you start​

You need an Algolia application. From the Algolia dashboard, open Settings → API Keys and keep these to hand:

  • the Application ID
  • the Search-Only API Key
  • the Admin API Key

Connect​

  1. Go to Settings → Tangible SearchSync → Connection Setup.

  2. Under Search Backend, set Backend to Algolia.

  3. Under Algolia API Details, fill in:

    FieldValue
    Application IDYour 10-character application ID
    Search-Only API KeyThe key used in visitors' browsers
    Admin API KeyThe key the plugin uses to write to your indexes. It stays on the server
  4. Click Save Settings.

SearchSync only registers Algolia once both the Application ID and the Admin API Key are filled in.

tip

Switching backends doesn't clear the credentials you've saved for the others, so you can move between them without re-entering keys.

Things to know​

  • Sorting on Algolia uses replica indexes. SearchSync can create them for you from an index's Sort orders panel. See Create an index.
  • "Powered by Algolia": Algolia's free Build plan requires the logo. Add the Powered By (Algolia) widget to your View's filters; paid plans can leave it out.
  • Staging sites: when SearchSync detects a staging environment it pauses the API connection to protect your live index. See Staging mode.