integration_documentation:oxid
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
integration_documentation:oxid [2020/10/22 16:41] daniel |
integration_documentation:oxid [2022/01/17 15:36] florian removed |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Integration with Oxid plugin ===== | ||
| - | Supports OXID 4.x and 6.x and is used for Direct Integration. | + | ~~GOTO>integration_documentation:plugin:en:direct_integration:oxid~~ |
| - | + | ||
| - | + | ||
| - | ==== Download ==== | + | |
| - | + | ||
| - | === Findologic search & navigation === | + | |
| - | + | ||
| - | * At exchange.oxid-esales.com | + | |
| - | * [[https://exchange.oxid-esales.com/Frontend-and-User-Experience/Search-Navigation-and-Filters/Findologic-Search-Navigation-1-0-0-Stable-CE-4-7-x-6-2-x.html?listtype=search&searchparam=findologic|Oxid 4.7.x - 6.2.x CE]] | + | |
| - | * [[https://exchange.oxid-esales.com/Frontend-and-User-Experience/Search-Navigation-and-Filters/Findologic-Search-Navigation-1-0-0-Stable-EE-PE-4-7-x-5-0-x-6-2-x.html?listtype=search&searchparam=findologic|Oxid 4.7.x/5.0.x - 6.2.x PE / EE]] | + | |
| - | + | ||
| - | === Findologic export === | + | |
| - | + | ||
| - | * Download [[https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_4_6_export_plugin.zip|Findologic export plugin]]. | + | |
| - | + | ||
| - | ==== Install search & navigation plugin ==== | + | |
| - | + | ||
| - | * Open the OXID admin and activate the module **Findologic - Search & Navigation Platform**. | + | |
| - | + | ||
| - | * Click on Settings and insert the shop key provided by Findologic and press save. | + | |
| - | + | ||
| - | {{:integration_documentation:plugins:oxid_shopkey.png|}} | + | |
| - | + | ||
| - | * Clear shop cache or remove tmp files with: | + | |
| - | <code shell> | + | |
| - | rm <shop_directory>/source/tmp/* | + | |
| - | </code> | + | |
| - | + | ||
| - | ==== Install export plugin ==== | + | |
| - | + | ||
| - | * See also [[https://docs.oxid-esales.com/developer/en/6.2/development/modules_components_themes/module/tutorials/module_setup.html|OXID documentation]]. | + | |
| - | + | ||
| - | * Copy the **findologic-export** folder to the plugin directory at **<shop_directory>/source/modules**. | + | |
| - | + | ||
| - | * Install module configuration: | + | |
| - | <code shell> | + | |
| - | cd <shop_directory> | + | |
| - | vendor/bin/oe-console oe:module:install-configuration source/modules/findologic-export/findologic-export | + | |
| - | </code> | + | |
| - | + | ||
| - | * Register module package in project composer.json: | + | |
| - | <code shell> | + | |
| - | cd <shop_directory> | + | |
| - | composer config repositories.findologic/findologic-export path source/modules/findologic-export/findologic-export | + | |
| - | composer require findologic/export | + | |
| - | </code> | + | |
| - | + | ||
| - | * Install dependencies: | + | |
| - | <code shell> | + | |
| - | cd <shop_directory>/source/modules/findologic-export/findologic-export | + | |
| - | composer install | + | |
| - | </code> | + | |
| - | + | ||
| - | * Open the OXID admin and activate the module **Findologic - Export**. | + | |
| - | + | ||
| - | ==== Product export ==== | + | |
| - | + | ||
| - | For the functionality of the plugin it's essential to export the product data from the shop to Findologic. | + | |
| - | For this purpose, the Findologic export library [[https://github.com/findologic/libflexport|libflexport]] | + | |
| - | is included. | + | |
| - | + | ||
| - | <note tip>By default the export contains only demo product data, it's necessary export the actual product data with the help of libflexport.</note> | + | |
| - | + | ||
| - | The export is triggerred by the [[https://github.com/findologic/plugin-oxid-di|plugin-oxid-di]] module and | + | |
| - | calls | + | |
| - | <code php>FindologicExport::startExport</code> | + | |
| - | + | ||
| - | Please use this example and modify it to your needs. The library provides you with the functionality to export XML according to the [[xml_export_documentation:xml_format|xml export documentation]]. The exported XML will be validated against a predefined [[https://github.com/findologic/xml-export/blob/master/src/main/resources/findologic.xsd|XSD Schema]]. | + | |
| - | + | ||
| - | ==== Run export ==== | + | |
| - | + | ||
| - | The export can be triggered by URL in your browser: | + | |
| - | + | ||
| - | <code> | + | |
| - | https://<SHOP_URL>/findologic_export.php?shopkey=<SHOP_KEY>&start=<NUMBER>&count=<NUMBER> | + | |
| - | </code> | + | |
| - | + | ||
| - | * **shopkey:** API key provided by Findologic | + | |
| - | * **start:** 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]]. | + | |
| - | + | ||
| - | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | + | |