integration_documentation:shopware
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
integration_documentation:shopware [2020/02/20 15:22] florian created |
integration_documentation:shopware [2020/06/24 15:55] florian |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| ==== General ==== | ==== General ==== | ||
| - | The FINDOLOGIC Shopware plugin needs to be implemented in the shop to export products and the relevant data for successful implementation of FINDOLOGIC search. Besides product export, the plugin also injects the main FINDOLOGIC snippet and automatically handles the implementation of the API or the Direct Integration. | + | The Findologic Shopware plugin needs to be implemented in the shop to export products and the relevant data for successful implementation of Findologic search. Besides product export, the plugin also injects the main Findologic snippet and automatically handles the implementation of the API or the Direct Integration. |
| The plugin is going through all the shop's data, finding valid products to export. In order to be exported, following conditions must be met: | The plugin is going through all the shop's data, finding valid products to export. In order to be exported, following conditions must be met: | ||
| Line 22: | Line 22: | ||
| ==== Installation ==== | ==== Installation ==== | ||
| - | The FINDOLOGIC plugin installation procedure is basically the same as for any other Shopware 5 plugin. It can be summed up in a few simple steps: | + | The Findologic plugin installation procedure is basically the same as for any other Shopware 5 plugin. It can be summed up in a few simple steps: |
| - | <note important>Before you install a new FINDOLOGIC plugin, please remove any other old FINDOLOGIC plugin.</note> | + | <note important>Before you install a new Findologic plugin, please remove any other old Findologic plugin.</note> |
| - | * The FINDOLOGIC plugin needs to be downloaded and installed via the Shopware store (see link above) or the Plugin Manager in the Shopware backend. | + | * The Findologic plugin needs to be downloaded and installed via the Shopware store (see link above) or the Plugin Manager in the Shopware backend. |
| {{:integration_documentation:direct_integration:shopware_di_1.png|}} | {{:integration_documentation:direct_integration:shopware_di_1.png|}} | ||
| Line 48: | Line 48: | ||
| * In the “Configuration” tab you have to: | * In the “Configuration” tab you have to: | ||
| - | * Enter the shopkey provided by FINDOLOGIC. | + | * Enter the shopkey provided by Findologic. |
| - | * Enter the CSS classes, which specify the containers where the content of FINDOLOGIC is loaded into. Find more information about this topic [[https://docs.findologic.com/doku.php?id=integration_documentation:direct_integration|here]]. | + | * Enter the CSS classes, which specify the containers where the content of Findologic is loaded into. Find more information about this topic [[https://docs.findologic.com/doku.php?id=integration_documentation:direct_integration|here]]. |
| - | {{:integration_documentation:plugins:shpwarepluginconfig.png|}} | + | {{:integration_documentation:plugin-config.jpg|}} |
| * After you fill in this form, click “Save”. | * After you fill in this form, click “Save”. | ||
| <note important>Shopkey must be entered in valid format or error will be shown</note> | <note important>Shopkey must be entered in valid format or error will be shown</note> | ||
| + | <note>You can test the current integration in a staging via the "Findologic Test" button.</note> | ||
| - | * In order for the //category// and the //vendor// block of the FINDOLOGIC Smart Suggest to work properly it is necessary to set the minimal allowed length of the search word to 0. | + | * In order for the //category// and the //vendor// block of the Findologic Smart Suggest to work properly it is necessary to set the minimal allowed length of the search word to 0. |
| {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} | {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} | ||
| Line 71: | Line 72: | ||
| Three parameters are necessary for successfully running an export: | Three parameters are necessary for successfully running an export: | ||
| - | * shopkey → <SHOPKEY> provided by FINDOLOGIC | + | * shopkey → <SHOPKEY> provided by Findologic |
| * start → <NUMBER> that should not be lower than zero | * start → <NUMBER> that should not be lower than zero | ||
| * count → <NUMBER> that should not be lower than zero | * count → <NUMBER> that should not be lower than zero | ||
| Line 81: | Line 82: | ||
| ==== Additional templates ==== | ==== Additional templates ==== | ||
| - | To be able to provide all the FINDOLOGIC features which are not support by Shopware out of the box, you need to implement additional templates within the search template of the shop. | + | To be able to provide all the Findologic features which are not support by Shopware out of the box, you need to implement additional templates within the search template of the shop. |
| **Promotions** | **Promotions** | ||
| Line 113: | Line 114: | ||
| ==== Export customization ==== | ==== Export customization ==== | ||
| - | The plugin can be extended by following the [[https://developers.shopware.com/developers-guide/plugin-extension-by-plugin/|Shopware plugin system standard]]. All important classes are registerd as services. FINDOLOGIC provides a boilerplate plugin on [[https://github.com/findologic/extend-shopware-unified|Github]] which can be copied and used as a quickstart to customize the export. | + | The plugin can be extended by following the [[https://developers.shopware.com/developers-guide/plugin-extension-by-plugin/|Shopware plugin system standard]]. All important classes are registerd as services. Findologic provides a boilerplate plugin on [[https://github.com/findologic/extend-shopware-unified|Github]] which can be copied and used as a quickstart to customize the export. |
| ---- | ---- | ||
| Line 120: | Line 121: | ||
| * Filters / Facets | * Filters / Facets | ||
| - | * In the FINDOLOGIC customer account you can set and configure the filters which should be displayed in the shop. | + | * In the Findologic customer account you can set and configure the filters which should be displayed in the shop. |
| - | * The order of the filters is specified by FINDOLOGIC and the visualization is handled by the Shopware template. | + | * The order of the filters is specified by Findologic and the visualization is handled by the Shopware template. |
| * Upgrading from earlier versions | * Upgrading from earlier versions | ||