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 | ||
|
integration_documentation:shopware [2020/10/06 07:22] daniel |
integration_documentation:shopware [2021/01/25 14:20] dominik removed |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Integration with Shopware 5 Plugin ===== | + | {{:integration_documentation:plugins:sw5-logo.png?nolink&400|}} |
| + | |||
| + | ===== Shopware 5 plugin integration ===== | ||
| ==== Download from Shopware store ==== | ==== Download from Shopware store ==== | ||
| * [[https://store.shopware.com/en/fin1848466805161f/findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] | * [[https://store.shopware.com/en/fin1848466805161f/findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] | ||
| + | |||
| + | ---- | ||
| ==== Installation ==== | ==== Installation ==== | ||
| Line 9: | Line 13: | ||
| * Install the plugin via the Shopware store or the plugin manager in the Shopware backend. | * Install the plugin via the Shopware store or the plugin manager in the Shopware backend. | ||
| * Activate the plugin. | * Activate the plugin. | ||
| + | |||
| + | ---- | ||
| ==== Plugin configuration ==== | ==== Plugin configuration ==== | ||
| Line 24: | Line 30: | ||
| * **Integration (read only):** This field is set automatically and shows the used integration, either Direct Integration or API. | * **Integration (read only):** This field is set automatically and shows the used integration, either Direct Integration or API. | ||
| * **Findologic Test:** This button is shown when the Findologic integration is still in staging mode. Clicking the button will redirect you to the shop frontend, where Findologic can be tested. Please be aware that a successful product export must happen before the test mode can be used. | * **Findologic Test:** This button is shown when the Findologic integration is still in staging mode. Clicking the button will redirect you to the shop frontend, where Findologic can be tested. Please be aware that a successful product export must happen before the test mode can be used. | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== Findologic Staging mode ==== | ||
| + | |||
| + | During integration the Findologic service can be tested with the //Findologic Test// button or by calling | ||
| + | |||
| + | <code> | ||
| + | https://<SHOP_URL>/?findologic=on | ||
| + | </code> | ||
| + | |||
| + | The orange Findologic staging banner should be shown. | ||
| + | |||
| + | {{:integration_documentation:shopware_5_staging_mode.png?direct|}} | ||
| + | |||
| + | <note tip>When the staging mode is used for the first time it's necessary to reload the page with **Ctrl + Shift + R**</note> | ||
| ==== Configure search word length ==== | ==== Configure search word length ==== | ||
| + | * In order for the **category** and the **vendor** suggestions of the Findologic Smart Suggest to work properly it is necessary to set the minimal allowed length of the search word to 0. | ||
| + | |||
| + | * Clear Shopware cache after saving the setting. | ||
| - | * 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|}} | ||
| - | |||
| - | * Clear Shopware cache. | ||
| ---- | ---- | ||
| - | ==== Running export ==== | + | ==== Run export ==== |
| - | The export is called via URL. For example: <SHOP_URL>/findologic?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER> | + | The export can be triggered by URL in your browser: |
| - | Three parameters are necessary for successfully running an export: | + | <code> |
| + | https://<SHOP_URL>/findologic?shopkey=<SHOP_KEY>&start=<NUMBER>&count=<NUMBER> | ||
| + | </code> | ||
| - | * shopkey → <SHOPKEY> provided by Findologic | + | * **shopkey:** API key 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 lower than zero and “start” number |
| This export url has to be set in the Findologic Account [[https://account.findologic.com/#/app/search-navigation/import-export|Settings]], see [[customer_account:import-export|documentation]]. | This export url has to be set in the Findologic Account [[https://account.findologic.com/#/app/search-navigation/import-export|Settings]], see [[customer_account:import-export|documentation]]. | ||
| + | |||
| + | Products are going to be exported when: | ||
| + | * Product is active. | ||
| + | * Active category is set. | ||
| + | * Product is visible in standard search and product detail page. | ||
| + | |||
| If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | ||
| Line 54: | Line 84: | ||
| ---- | ---- | ||
| - | ==== Additional templates ==== | + | ==== Integration of promotions ==== |
| - | + | ||
| - | 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** | + | |
| The promotion template will be provided by the plugin if there is a match with the query and can be added via the following smarty-plugin: | The promotion template will be provided by the plugin if there is a match with the query and can be added via the following smarty-plugin: | ||
| Line 82: | Line 108: | ||
| ---- | ---- | ||
| - | ==== Implementing Smart Did-You-Mean ==== | + | ==== Integration of Smart Did-You-Mean ==== |
| + | See [[integration_documentation:plugins:shopware_smart_did_you_mean|documentation]]. | ||
| - | In order to implement Smart Did-You-Mean please have a look at the following [[integration_documentation:plugins:shopware_smart_did_you_mean|documentation]]. | ||
| ==== 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 [[https://github.com/findologic/plugin-shopware-5-extension|plugin-shopware-5-extension]] which can be copied and used as a quickstart to customize the export. |
| ---- | ---- | ||
| - | |||
| - | 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: | ||
| - | |||
| - | * product must be set to active | ||
| - | * active category must be set | ||
| - | * product is visible in standard search and on product detail site | ||
| - | |||
| ==== Troubleshooting ==== | ==== Troubleshooting ==== | ||