integration_documentation:direct_integration

integration_documentation:direct_integration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
integration_documentation:direct_integration [2020/06/15 09:52]
amil
integration_documentation:direct_integration [2022/03/16 11:44] (current)
florian [Implementing the Findologic snippet]
Line 1: Line 1:
-===== Integration documentation - Direct Integration =====+===== Direct Integration =====
  
 ==== Overview ==== ==== Overview ====
  
-The Findologic-scripts are binding events on the search field of the shop. When a user submits the form of the search field, the request gets sent via AJAX directly to the Findologic servers. This offers a massive speed boost and lowers the load on the shop side, because it is not necessary that the request is being sent to the shop's server first+The Findologic-scripts are binding events on the search field of the shop. When a user submits the form of the search field, the request gets sent via AJAX directly to the Findologic servers.
  
-Findologic loads the entire search result ​as defined in the [[customer_account:​template_manager|template manager]] ​and delivers the rendered HTML to the shop. The HTML in this response will be placed in a container of the shop. This container must have **unique selectors**. As a customer of Findologic you have to add the given classes to the existing main container in your shop.+Findologic loads the entire search result and delivers the rendered HTML to the shop. The HTML in this response will be placed in a container of the shop. This container must have **unique selectors**. As a customer of Findologic you have to add the given classes to the existing main container in your shop.
  
 ------ ------
Line 11: Line 11:
 ==== Implementing the Findologic snippet ==== ==== Implementing the Findologic snippet ====
  
-You can find the snippet for your channel in the [[https://secure.findologic.com/​login.symfony/​web/​app.php/​smartsuggest/​edit|Findologic ​customer login]]. Please add this snippet in the ''<​head>''​-section of your source code. +You can find the snippet for your channel in your [[https://account.findologic.io|Findologic ​account]]. Please add this snippet in the ''<​head>''​-section of your source code. 
  
 <​note>​Please note that the usage of Google Tag Manager will disable the flickerfree-functionality of the snippet as the scripts are getting loaded too late.</​note>​ <​note>​Please note that the usage of Google Tag Manager will disable the flickerfree-functionality of the snippet as the scripts are getting loaded too late.</​note>​
Line 26: Line 26:
 ---- ----
  
-==== Findologic navigation ​====+==== Navigation container ​====
  
-The Findologic ​navigation allows you to use the Findologic filters ​on category pages. \\ +For using Findologic on category pages you have to provide ​the ''​cat_url''​s in a valid manner. ​[[xml_export_documentation:xml_format#​cat_url_examples|See our documentation about ''​cat_urls''​]] for more information. 
-You will also have all the benefits of the Direct Integration and you can use our merchandising feature ​[[customer_account:product_pushing|product pushing]].+To ensure proper functionality,​ the Findologic Direct Integration must have access to the main container of the shop. To do so, it is necessary to add the class ''​fl-navigation-result''​ to the corresponding,​ pre-existing container. 
 +This class has to be available **on every category page** of the shop. For the category pages, the HTML-response of Findologic contains both all found products and available filters for this category.
  
----- +{{ :integration_documentation:​fl-navigation-result.png |}}
- +
-==== Use the navigation in your shop ==== +
- +
-If you want to use Findologic in your category pages with Direct Integration,​ the requirements are as described below. +
- +
-**Export:** +
- +
-  * Make sure to export the correct ''​cat_urls''​ in the attributes, matching the Findologic [[xml_export_documentation:xml_format#​attributes|XML]] or [[csv_export_documentation:​csv_format#​attributes|CSV]] export scheme. +
-** +
-Shop frontend:​** +
- +
-  * The container for the filters with the id "fl-filters"​. +
-  * The container for the navigation ​results when choosing a filter wit the id "fl-searchresults"​. +
-  * See [[integration_documentation:​direct_integration:​|our documentation]] about Direct Integration for more information on this topic. +
- +
-**Findologic:​** +
- +
-  * The navigation needs to be integrated by Findologic. ​+
  
 ---- ----
Line 67: Line 50:
  
 {{tag>​Navigation Nav Selector}} {{tag>​Navigation Nav Selector}}
- 
----- 
- 
-==== Navigation container ==== 
- 
-For using Findologic on category pages you have to provide the ''​cat_url''​s in a valid manner. [[xml_export_documentation:​xml_format#​cat_url_examples|See our documentation about ''​cat_urls''​]] for more information. 
-To ensure proper functionality,​ the Findologic Direct Integration must have access to the main container of the shop. To do so, it is necessary to add the class ''​fl-navigation-result''​ to the corresponding,​ pre-existing container. 
-This class has to be available **on every category page** of the shop. For the category pages, the HTML-response of Findologic contains both all found products and available filters for this category. 
- 
-{{ :​integration_documentation:​fl-navigation-result.png |}} 
  
 ---- ----
Line 96: Line 69:
  
 </​code>​ </​code>​
- 
- 
-