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/10/23 10:21]
daniel
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]].+
  
 ---- ----
Line 39: Line 33:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=customer_account:template_manager:​template_manager_plugins">Template manager plugins</a>+        <a href="​doku.php?​id=integration_documentation:parameters">Common request parameters</a>
     </h3>     </h3>
 </​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.+
  
 ---- ----
  
-===== API integration ===== +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​response_xml">​XML response</​a>​ 
 +    </​h3>​ 
 +</​html>​
  
-<​note>​The service ​of Findologic ​is available after the first successful datasync process.</​note> ​+[[integration_documentation:​response_xml|Here]] you can find more about the response ​of Findologic ​in XML format. 
 + 
 +----
  
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="doku.php?​id=integration_documentation:request">Search request to Findologic</a>+        <a href="https://​service.findologic.com/​ps/​centralized-frontend/​spec/​">JSON response</a>
     </h3>     </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:request|Here]] you can find detailed ​information about the search request submitted from your shopsystem to Findologic.+ 
 +[[https://​service.findologic.com/​ps/​centralized-frontend/​spec/​|Here]] you can find detailed ​API specification of our JSON response format.
  
 ---- ----
Line 64: Line 64:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="doku.php?​id=integration_documentation:request_navigation">Navigation request to Findologic</a>+        <a href="https://​lisa.findologic.io/​v1/​ui/​">Li.S.A. response</a>
     </h3>     </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:​request_navigation|Here]] you can find detailed information about the navigation request submitted from your shopsystem to Findologic. 
  
 +[[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>​
     <h3>     <h3>
-        <a href="doku.php?id=integration_documentation:​parameters">Common request parameters</a>+        <a href="https://​docs.findologic.com/​lib/​exe/​fetch.php?media=lisa_style_guide.pdf">Li.S.A. styleguide</a>
     </h3>     </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:​parameters|Here]] you can find description of common parameters used in request to Findologic.+You can download ​styleguide for your Li.S.A. integration as PDF download {{ :​lisa_style_guide.pdf |here}}.
  
 ---- ----
Line 84: Line 84:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="doku.php?id=integration_documentation:​response_xml">XML response from Findologic</a>+        <a href="https://​docs.findologic.com/​lib/​exe/​fetch.php?media=assisted_suggest_style_guide.pdf">Assisted Suggest styleguide</a>
     </h3>     </h3>
 </​html>​ </​html>​
  
-[[integration_documentation:response_xml|Here]] you can find more about the response of Findologic in XML format.+You can download a styleguide for your Assisted Suggest integration as a PDF download {{ :assisted_suggest_style_guide.pdf ​|here}}.
  
 ---- ----
Line 94: Line 94:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="https://​service.findologic.com/​ps/​centralized-frontend/​spec/​">JSON response from Findologic</a>+        <a href="doku.php?​id=integration_documentation:product_update_API">Product Update API</a>
     </h3>     </h3>
 </​html>​ </​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.
  
-[[https://service.findologic.com/ps/centralized-frontend/spec/​|Here]] ​you can find a detailed API specification of our JSON response format.+ 
 +===== Instant Frontend =====  
 + 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​instant_frontend:product_listing">​Product List</a> 
 +    </h3> 
 +</​html>​ 
 + 
 +Following the link above you can reach our Product List documentation 
 + 
 +---- 
 + 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​instant_frontend:​shopping_guide">​Shopping Guide</a> 
 +    </h3> 
 +</html> 
 + 
 +Following the link above you can reach our Shopping Guide documentation
  
 ---- ----
Line 107: Line 127:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=integration_documentation:​magento">​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​direct_integration:​bigcommerce">​ 
-            <img src="​https://​plugin.demo.findologic.com/​dokuwiki-logos/magento.png" style="​margin-right:​10px">​ +            <img src="​https://​docs.findologic.com/​lib/exe/​fetch.php?​media=integration_documentation:​plugins:​bigcommerce_icon.png" style="​width:50px;margin-right:​10px">​ 
-            ​Magento 2 plugin ​integration+            ​BigCommerce app integration
         </a>         </a>
     </h3>     </h3>
Line 118: Line 138:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=integration_documentation:​oxid">​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​api:​plentymarkets">​ 
-            <img src="​https://​plugin.demo.findologic.com/​dokuwiki-logos/oxid.png" style="​margin-right:​5px">​ +            <img src="​https://​docs.findologic.com/​lib/exe/​fetch.php?​media=integration_documentation:​plugins:​plenty_logo.png" style="​width:50px;margin-right:​10px">​ 
-            ​Oxid plugin integration+            ​Plentymarkets ​plugin integration
         </a>         </a>
     </h3>     </h3>
Line 129: Line 149:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=integration_documentation:​plentymarkets_ceres_plugin">​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​direct_integration:​shopify">​ 
-            <img src="​https://​plugin.demo.findologic.com/​dokuwiki-logos/plenty.png" style="​margin-right:​10px">​ +            <img src="​https://​docs.findologic.com/​lib/exe/​fetch.php?​media=integration_documentation:​plugins:​shopify_logo.png" style="​width:50px;margin-right:​10px">​ 
-            ​Plentymarkets Ceres plugin ​integration+            ​Shopify app integration
         </a>         </a>
     </h3>     </h3>
Line 140: Line 160:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=integration_documentation:​shopify">​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​integration:​shopware_5">​ 
-            <img src="​https://​plugin.demo.findologic.com/​dokuwiki-logos/shopify.png" style="​margin-right:​10px">​ +            <img src="​https://​docs.findologic.com/​lib/exe/​fetch.php?​media=integration_documentation:​plugins:​sw5_logo.png" style="​width:50px;margin-right:​10px">​ 
-            ​Shopify ​plugin integration+            ​Shopware 5 plugin integration
         </a>         </a>
     </h3>     </h3>
Line 151: Line 171:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=integration_documentation:​shopware">​ +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​integration:​shopware_6">​ 
-            <img src="​https://​plugin.demo.findologic.com/​dokuwiki-logos/sw5.jpg" style="​margin-right:​10px">​ +            <img src="​https://​docs.findologic.com/​lib/exe/​fetch.php?​media=integration_documentation:​plugins:​sw6_logo.png" style="​width:50px;margin-right:​10px">​ 
-            Shopware ​plugin integration+            Shopware ​plugin integration
         </a>         </a>
     </h3>     </h3>
Line 162: Line 182:
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="​doku.php?​id=integration_documentation:​shopware_6">​ +        <a href="​doku.php?​id=integration_documentation:​shopware_6_app">​ 
-            <img src="​https://​plugin.demo.findologic.com/​dokuwiki-logos/sw6.png" style="​margin-right:​10px">​ +            <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+            Shopware 6 app integration
         </a>         </a>
     </h3>     </h3>
Line 170: Line 190:
  
  
-===== Smart Suggest ===== +---- 
 +===== Assisted Suggest & Smart Suggest =====  
  
 <​html>​ <​html>​
     <h3>     <h3>
-        <a href="doku.php?​id=integration_documentation:customize_smart_suggest">Smart Suggest ​customization</a>+        <a href="https://​service.findologic.com/​ps/​centralized-frontend/​spec/​">Assisted ​Suggest ​API documentation</a>
     </h3>     </h3>
 </​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.
-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="​https://​service.findologic.com/​ps/​centralized-frontend/​spec/">​Smart Suggest API documentation</​a>​
 +    </h3>
 +</​html>​
 +
 +Following the link above you can reach our API documentation (see the schema "Smart Suggest response (V3 and below)"​).
 +
 +----
 +
 +<​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 193: Line 233:
 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.). ​
 +
 +