integration_documentation:plugin:en:direct_integration:bigcommerce
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:plugin:en:direct_integration:bigcommerce [2021/01/27 18:11] daniel |
integration_documentation:plugin:en:direct_integration:bigcommerce [2021/04/28 21:27] daniel |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{:integration_documentation:bigcommerce-logo-dark.png?nolink&600|}} | {{:integration_documentation:bigcommerce-logo-dark.png?nolink&600|}} | ||
| - | ===== Integration with BigCommerce plugin ===== | + | ===== Integration with BigCommerce app ===== |
| + | The app can be used for [[integration_documentation:direct_integration|Direct Integration]]. | ||
| ==== Download ==== | ==== Download ==== | ||
| - | //Available soon at [[https://www.bigcommerce.com/apps|BigCommerce App store]]// | + | // Available soon at [[https://www.bigcommerce.com/apps|BigCommerce App store]]// |
| - | | + | |
| ==== Installation ==== | ==== Installation ==== | ||
| - | * Open the BigCommerce backend and go to ... | + | Press the **Install** button to start the installation process. |
| - | * Click on Settings and insert the shop key provided by Findologic and press save. | + | {{:integration_documentation:direct_integration:bigcommerce_install.png?direct|}} |
| - | {{:integration_documentation:plugins:oxid_shopkey.png|}} | + | In order to integrate the Findologic service to your shop it's necessary to have the permission, use the **Confirm** button to accept. |
| - | * Clear shop cache or remove tmp files with: | + | {{:integration_documentation:direct_integration:bigcommerce_confirm.png?direct|}} |
| - | <code shell> | + | |
| - | rm <shop_directory>/source/tmp/* | + | |
| - | </code> | + | |
| - | ==== Install export plugin ==== | + | When the installation was successful the Findologic app configuration page is shown. |
| - | * See also [[https://docs.oxid-esales.com/developer/en/6.2/development/modules_components_themes/module/tutorials/module_setup.html|OXID documentation]]. | + | Insert configuration below and press **Save** button. |
| - | * Copy the **findologic-export** folder to the plugin directory at **<shop_directory>/source/modules**. | + | * **Active:** Activate to enable Findologic for your shop - **required** |
| + | * **Shopkey:** Enter the shopkey provided by Findologic - **required** | ||
| - | * Install module configuration: | + | {{:integration_documentation:direct_integration:bigcommerce_config.png?direct|}} |
| - | <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 ==== | ==== Product export ==== | ||
| - | For the functionality of the plugin it's essential to export the product data from the shop to Findologic. | + | <note tip>Please be aware that the product export isn't included with the app, for the functionality of the Findologic service it's necessary to **provide an own product export**.</note> |
| - | 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 to 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 ==== | + | |
| - | + | ||
| - | <code> | + | |
| - | https://<SHOP_URL>/<EXPORT_PATH>?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER> | + | |
| - | </code> | + | |
| - | * **shopkey:** <SHOPKEY> provided by Findologic | + | For this purpose we recommend to use the [[https://developer.bigcommerce.com/api-docs/store-management/catalog/catalog-overview|BigCommerce Catalog API]] to retrieve the product data. |
| - | * **start:** <NUMBER> that should not be lower than zero | + | |
| - | * **count:** <NUMBER> that should not be lower than zero | + | |
| + | The Findologic export library [[https://github.com/findologic/libflexport|libflexport]] should help to get the data from the Catalog API to the right format. | ||
| - | 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]]. | + | Both XML or CSV formats are supported: |
| + | * [[xml_export_documentation:xml_format|XML export format]]. | ||
| + | * [[csv_export_documentation:csv_format|CSV export format]]. | ||
| - | The generated XML is validated against our predefined [[https://raw.githubusercontent.com/Findologic/xml-export/master/src/main/resources/Findologic.xsd|XSD scheme]] and built with our export library [[https://github.com/Findologic/libflexport|libflexport]]. | + | The exported XML will be validated against a predefined [[https://github.com/findologic/xml-export/blob/master/src/main/resources/findologic.xsd|XSD Schema]]. |
| 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]]. | ||