Algolia E-commerce connector

Edition

Incubator (services)

Issues

Git

Git

Latest

1.0

Compatible with Magnolia 6.2.

This module provides an implementation of Magnolia ecommerce connector using Algolia. Though Algolia is at first sight a search engine, the idea here is to use it as a source of data for the ecommerce connector.

This module is at the INCUBATOR level.

It has been created for a proof of concept. The Algolia index attributes mapping may change in future releases.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.ecommerce</groupId>
  <artifactId>magnolia-ecommerce-algolia-connector</artifactId>
  <version>1.0</version>
</dependency>
You might also want to check out the E-commerce module for other useful ecommerce connectors. They are not just third party ecommerce vendor implementation, but also some utility modules like the magnolia-ecommerce-ui one which would let you ensure that your configuration is working.

Usage

The module requires two indices in Algolia to work:

  • one holding products

  • the second one for categories

Product index

You can call the product index any name you like, but we will use product_index as an example.

All product records need to have at least following attributes and settings:

Attribute name Description Attributes for faceting

objectID

The Algolia object id. Is used as a unique key for the product SKU, mapping might change in future version

Not required

productName

The product name

Not required

shortDescription

The product description

Not required

priceFormatted

The product price

Not required

catTags

The product categories list

Filter only

productPicture

The product picture link

Not required

Category index

You can call the category index any name you like, but we will use category_index as an example.

All category records need to have at least following attributes and settings:

Attribute name Description Attributes for faceting

id

The unique category id

Filter only

label

The category name

Not required

parent

The category parent id (set to 0 if no parent)

Filter only

Algolia ecommerce module configuration

Enable and configure the module by using a decoration as below:

<light-module-name>/decorations/ecommerce-algolia-connector/ecommerces/algolia.yaml
enabled: true
connections:
  magnoliaAlgolia:
    enabled: true
    parameters:
      applicationId: ALGOLIA_APPLICATION_ID
      apiKey: ALGOLIA_API_KEY
      indexProducts: product_index
      indexCategories: category_index

Changelog

The Changelog covers all updates related to this module.

Version Notes

1.0.0

Initial release of the module.

Feedback