integration_documentation

integration_documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
integration_documentation [2020/06/26 11:12]
florian [API integration]
integration_documentation [2023/04/12 21:37] (current)
nadine [Instant Frontend]
Line 2: Line 2:
  
  
-Here you can find detailed documentations about the integration of FINDOLOGIC ​into shopsystems,​ which are supported by FINDOLOGIC. \\   +Here you can find detailed documentations about the integration of Findologic ​into specific shop systems. \\   
-You can also find other topics regarding the integration of FINDOLOGIC ​in this section. \\+You can also find other topics regarding the integration of Findologic ​in this section. \\
  
 \\ \\
  
-===== Direct Integration ​===== +===== API integration ​=====  
 + 
 +<​note>​The service of Findologic is available after the first successful datasync process.</​note> ​
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​request">Search request to Findologic</​a>​ 
-                <a href="​doku.php?​id=integration_documentation:​direct_integration">Direct Integration</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-You can find a detailed documentation about the Direct Integration ​[[integration_documentation:​direct_integration|here]].+[[integration_documentation:​request|Here]] you can find detailed information about the search request submitted from your shopsystem to Findologic.
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:request_navigation">Navigation request to Findologic</​a>​ 
-                <a href="​doku.php?​id=customer_account:template_manager">Template manager</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-The template manager allows you to edit the search result pages to your desire.\\ +[[integration_documentation:request_navigation|Here]] you can find detailed information about the navigation request submitted from your shopsystem to Findologic.
-This is **by default only possible if you are still in integration phase.** \\ +
-You can find the documentation about this topic [[customer_account:template_manager|here]].+
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:parameters">Common request parameters</​a>​ 
-                <a href="​doku.php?​id=customer_account:template_manager:​template_manager_plugins">Template manager plugins</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-FINDOLOGIC provides many template manager plugins for you, that make changes much easier. +[[integration_documentation:parameters|Here]] you can find a description of common parameters used in a request to Findologic.
-[[customer_account:​template_manager:template_manager_plugins|Here]] you can find everything regarding this topic.+
  
 ---- ----
  
-===== Plugin integration ===== +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​response_xml">​XML response</​a>​ 
 +    </​h3>​ 
 +</​html>​ 
 + 
 +[[integration_documentation:​response_xml|Here]] you can find more about the response of Findologic in XML format. 
 + 
 +----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="https://​service.findologic.com/​ps/​centralized-frontend/​spec/​">JSON response</​a>​ 
-                <a href="doku.php?​id=integration_documentation:​plentymarkets_ceres_plugin">Integration with plentymarkets Ceres</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-[[integration_documentation:plentymarkets_ceres_plugin|Here]] you can find a detailed ​documentation how to integrate FINDOLOGIC with plentymarkets Ceres.+ 
 +[[https://​service.findologic.com/​ps/​centralized-frontend/​spec/​|Here]] you can find a detailed ​API specification of our JSON response format.
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="https://​lisa.findologic.io/​v1/​ui/​">Li.S.A. response</​a>​ 
-                <a href="doku.php?​id=integration_documentation:​shopware">Integration with the Shopware 5 Plugin</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-[[integration_documentation:​shopware|Here]] you can find a detailed documentation how to integrate FINDOLOGIC with the Shopware 5 Plugin. 
  
 +[[https://​lisa.findologic.io/​v1/​ui/​|Here]] you can find a detailed API specification for all the data you need to implement Li.S.A. in your shop.
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="https://​docs.findologic.com/​lib/​exe/​fetch.php?media=lisa_style_guide.pdf">Li.S.A. styleguide</​a>​ 
-                <a href="doku.php?id=integration_documentation:​shopware_6">Integration with the Shopware 6 Plugin</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-[[integration_documentation:​shopware_6|Here]] you can find detailed documentation how to integrate FINDOLOGIC with the Shopware 6 Plugin.+You can download ​styleguide for your Li.S.A. integration as a PDF download {{ :​lisa_style_guide.pdf |here}}.
  
 ---- ----
  
 +<​html>​
 +    <h3>
 +        <a href="​https://​docs.findologic.com/​lib/​exe/​fetch.php?​media=assisted_suggest_style_guide.pdf">​Assisted Suggest styleguide</​a>​
 +    </h3>
 +</​html>​
 +
 +You can download a styleguide for your Assisted Suggest integration as a PDF download {{ :​assisted_suggest_style_guide.pdf |here}}.
 +
 +----
 +
 +<​html>​
 +    <h3>
 +        <a href="​doku.php?​id=integration_documentation:​product_update_API">​Product Update API</​a>​
 +    </h3>
 +</​html>​
 +
 +[[https://​service.findologic.com/​ps/​centralized-frontend/​spec/​|Here]] you can find a detailed API specification for all the data you need to implement the Product Update API.
 +
 +
 +===== Instant Frontend ===== 
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​instant_frontend:​product_listing">Product List</​a>​ 
-                <a href="​doku.php?​id=integration_documentation:​shopify">Integration with the Shopify Plugin</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-[[integration_documentation:​shopify|Here]] ​you can find a detailed ​documentation ​how to integrate FINDOLOGIC with the Shopify Plugin.+Following the link above you can reach our Product List documentation. ​
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​instant_frontend:​shopping_guide">Shopping Guide</​a>​ 
-                <a href="​doku.php?​id=integration_documentation:​magento">Integration with the Magento Plugin</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-[[integration_documentation:​magento|Here]] ​you can find a detailed ​documentation ​how to integrate FINDOLOGIC with the Magento Plugin.+Following the link above you can reach our Shopping Guide documentation. ​
  
 ---- ----
-===== API integration =====  
  
-<​note>​The service of Findologic ​is available after the first successful datasync process.</​note> ​+===== Using a Findologic ​plugin ===== 
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​direct_integration:​bigcommerce">​ 
-                <a href="​doku.php?​id=integration_documentation:​request">Search request to Findologic</​a+            <img src="​https:​//​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​bigcommerce_icon.png"​ style="​width:​50px;​margin-right:​10px"​> 
-            </h3+            BigCommerce app integration 
-        </div+        </a
-        <p>+    </h3>
 </​html>​ </​html>​
- 
-[[integration_documentation:​request|Here]] you can find detailed information about the search request submitted from your shopsystem to Findologic. 
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​api:​plentymarkets">​ 
-                <a href="​doku.php?​id=integration_documentation:​request_navigation">​Navigation request to Findologic</​a+            <img src="​https:​//​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​plenty_logo.png"​ style="​width:​50px;​margin-right:​10px"​> 
-            </h3+            Plentymarkets plugin integration 
-        </div+        </a
-        <p>+    </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:​request_navigation|Here]] you can find detailed information about the navigation request submitted from your shopsystem to Findologic.+---- 
 + 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​direct_integration:​shopify">​ 
 +            <img src="​https://​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​shopify_logo.png"​ style="​width:​50px;​margin-right:​10px">​ 
 +            Shopify app integration 
 +        </​a>​ 
 +    </​h3>​ 
 +</​html>​
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​integration:​shopware_5">​ 
-                <a href="​doku.php?​id=integration_documentation:​parameters">Common request parameters</​a+            <img src="​https:​//​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​sw5_logo.png"​ style="​width:​50px;​margin-right:​10px"​> 
-            </h3+            Shopware 5 plugin integration 
-        </div+        </a
-        <p>+    </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:​parameters|Here]] you can find a description of common parameters used in a request to Findologic.+---- 
 + 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​integration:​shopware_6">​ 
 +            <img src="​https://​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​sw6_logo.png"​ style="​width:​50px;​margin-right:​10px">​ 
 +            Shopware 6 plugin integration 
 +        </​a>​ 
 +    </​h3>​ 
 +</​html>​
  
 ---- ----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​shopware_6_app">​ 
-                <a href="​doku.php?​id=integration_documentation:​response_xml">XML response from Findologic</​a+            <img src="​https:​//​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​sw6_logo.png"​ style="​width:​50px;​margin-right:​10px"​> 
-            </h3+            Shopware 6 app integration 
-        </div+        </a
-        <p>+    </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:​response_xml|Here]] you can find more about the response of Findologic in XML format. 
  
 ---- ----
 +===== Assisted Suggest & Smart Suggest ===== 
 +
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​https://​service.findologic.com/​ps/​centralized-frontend/​spec/">​Assisted Suggest API documentation</​a>​ 
-                <a href="​https://​service.findologic.com/​ps/​centralized-frontend/​spec/">​JSON response from Findologic</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
 +Following the link above you can reach our API documentation.
  
-[[https://​service.findologic.com/​ps/​centralized-frontend/​spec/​|Here]] you can find a detailed API specification of our JSON response format. +----
-===== Smart Suggest ===== +
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="https://​service.findologic.com/​ps/​centralized-frontend/​spec/​">​Smart Suggest ​API documentation</​a>​ 
-                <a href="doku.php?​id=integration_documentation:​customize_smart_suggest">​Smart Suggest ​customization</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-If you want to customize ​the Smart Suggest ​by your own, FINDOLOGIC offers an API documentation regarding this topic. +Following the link above you can reach our API documentation (see the schema "Smart Suggest ​response (V3 and below)"​).
-You can also try out your changes live in this documentation. Click [[integration_documentation:​customize_smart_suggest|here]] to get there.+
  
 +----
 +
 +<​html>​
 +    <h3>
 +        <a href="​doku.php?​id=integration_documentation:​customize_smart_suggest">​Smart Suggest styling</​a>​
 +    </h3>
 +</​html>​
 +
 +You can find information around Smart Suggest styling (including some styling examples) following the link above.
 ---- ----
  
Line 204: Line 226:
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​checklist">​Checklist for your own integration</​a>​ 
-                <a href="​doku.php?​id=integration_documentation:​checklist">​Checklist for your own integration</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
 If you are integrating by your own, we have made a [[integration_documentation:​checklist|checklist]] for your integration\\ If you are integrating by your own, we have made a [[integration_documentation:​checklist|checklist]] for your integration\\
-and what you have to keep in mind, when using FINDOLOGIC ​(export, search result, configuration,​ etc.). ​+and what you have to keep in mind, when using Findologic ​(export, search result, configuration,​ etc.). ​ 
 +