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 Last revision Both sides next revision | ||
|
integration_documentation:plugin:en:direct_integration:bigcommerce [2021/01/29 14:44] daniel |
integration_documentation:plugin:en:direct_integration:bigcommerce [2021/05/21 08:16] daniel |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | <markdown> | ||
| - | |||
| {{: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 at [[https://www.bigcommerce.com/apps/findologic|BigCommerce app store]]// |
| - | | + | |
| - | ## Installation | + | ==== Installation ==== |
| - | First when the installation page is shown press the **Install** button | + | Press the **Install** button to start the installation process. |
| {{:integration_documentation:direct_integration:bigcommerce_install.png?direct|}} | {{:integration_documentation:direct_integration:bigcommerce_install.png?direct|}} | ||
| Line 21: | Line 19: | ||
| {{:integration_documentation:direct_integration:bigcommerce_confirm.png?direct|}} | {{:integration_documentation:direct_integration:bigcommerce_confirm.png?direct|}} | ||
| - | When the installation was successful the Findologic app configuration page should be shown. | + | When the installation was successful the Findologic app configuration page is shown. |
| - | Insert the configuration and press **Save** button. | + | |
| - | * **Active:** Activate to enable Findologic search for your shop - **required** | + | Insert configuration below and press **Save** button. |
| - | * **Shopkey:** Enter the shopkey provided by Findologic - **required** | + | |
| + | * **Shopkey:** Enter the shopkey provided by Findologic - **required** | ||
| + | * **Active:** Activate to enable Findologic for your shop - **required** | ||
| - | {{:integration_documentation:direct_integration:bigcommerce_config.png?direct|}} | + | |
| + | {{:integration_documentation:direct_integration:bigcommerce_config.png|?direct}} | ||
| ==== Product export ==== | ==== Product export ==== | ||
| - | <note tip>The product export is not included, it's necessary to provide an own product export via url or file.</note> | + | <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 the functionality of the plugin it's essential to export the product data from the shop to 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. |
| - | For this purpose, the Findologic export library [[https://github.com/findologic/libflexport|libflexport]] | + | |
| - | can be used. | + | |
| + | The Findologic export library [[https://github.com/findologic/libflexport|libflexport]] should help to get the data from the Catalog API to the right format. | ||
| - | 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]]. | + | Both XML or CSV formats are supported: |
| - | + | * [[xml_export_documentation:xml_format|XML export format]]. | |
| - | ==== Call export with url ==== | + | * [[csv_export_documentation:csv_format|CSV export format]]. |
| - | + | ||
| - | <code> | + | |
| - | https://<SHOP_URL>/<EXPORT_PATH>?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER> | + | |
| - | </code> | + | |
| - | + | ||
| - | * **shopkey:** <SHOPKEY> provided by Findologic | + | |
| - | * **start:** <NUMBER> that should not be lower than zero | + | |
| - | * **count:** <NUMBER> that should not be lower than zero | + | |
| - | + | ||
| - | + | ||
| - | 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]]. | + | |
| - | + | ||
| - | + | ||
| - | ==== Provide export file ==== | + | |
| - | + | ||
| - | <code> | + | |
| - | https://<URL>/findologic.xml | + | |
| - | </code> | + | |
| - | + | ||
| - | Please see documentation to [[xml_export_documentation:xml_format|XML export format]]. | + | |
| - | + | ||
| - | <code> | + | |
| - | https://<URL>/findologic.csv | + | |
| - | </code> | + | |
| - | + | ||
| - | Please see documentation to [[csv_export_documentation:csv_format|CSV export format]]. | + | |
| + | 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]]. | ||
| - | |||
| - | </markdown> | ||