Synchronize search with Algolia

This example provides instructions to clone and configure the repository that contains the code required to synchronize data between Elastic Path Commerce Cloud and Algolia, and use webhooks to synchronize data.

Prerequisite

• Ensure that you have an account in the ngrok service to tunnel your development environment externally.
• Ensure that yarn and other dependencies are installed.

Procedure

1. To clone repository, run the following command:

   git clone https://github.com/moltin/examples.git
   

2. In the terminal, go to the examples/webhooks/sync-catalog-to-algolia directory.

3. Go to Algolia and do the following:

   1. Create an account.

   2. Create a new app with a name.

   3. Go to Settings > API Keys.

      Make a note of your Application ID and Admin API Key.

4. In the /sync-catalog-to-algolia directory, create an .env file and add the keys for the following environment variables:

   • ALGOLIA_APP_ID=
   • ALGOLIA_API_KEY=
   • MOLTIN_WEBHOOK_SECRET=

   Use any value that you want for MOLTIN_WEBHOOK_SECRET.

5. Run the following command and start the development server:

   yarn dev
   

   By default, the server starts on port 3000. If the server starts on a different port, use that port number in the next step.

6. Start ngrok using the following command:

   ngrok http 3000
   

   This exposes port 3000 externally.

7. Go to the ngrok status page and make a note of the URL.

8. Create a new integration in Commerce Manager by doing the following:

   1. Log into the Commerce Manager.

   2. Go to Settings > Integrations.

   3. Click New Integration.

   4. In the Integration details section, enter a name and description for your integration.

      We recommend to prefix the name with DEVELOPMENT for easier referencing.

   5. In the Configuration section, enter the ngrok URL and a secret key.

   6. In the Observes section, select the following options in *Category and Collection:

      • Created
      • Updated
      • Deleted

   7. Select Enabled.

   8. Click Save.

Related Resources

• Integrations
• Integrations API
• Synchronize search example (Source code)