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
Last revision Both sides next revision
integration_documentation [2018/07/06 10:19]
florian [XML-response from FINDOLOGIC]
integration_documentation [2023/03/14 16:06]
rihad [API integration]
Line 2: Line 2:
  
  
-//<​faicon fa fa-question-circle>​ [[#​frequently_asked_questions|Scroll down to see related articles in our FAQ-section]] ​about this topic.//+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\\
  
-Here you can find detailed documentations about the integration of FINDOLOGIC into shopsystems,​ which are supported by FINDOLOGIC. \\   +\\
-You can also find other topics regarding the integration of FINDOLOGIC in this section. ​\\+
  
-\\ +===== API integration ===== 
  
-==== Direct 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.
  
-==== Implementation of the navigation ​====+---- 
 + 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​request_navigation">​Navigation request to Findologic</​a>​ 
 +    </​h3>​ 
 +</​html>​ 
 + 
 +[[integration_documentation:​request_navigation|Here]] you can find detailed information about the navigation ​request submitted from your shopsystem to Findologic.
  
 ---- ----
 +
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​parameters">Common request parameters</​a>​ 
-                <a href="​doku.php?​id=integration_documentation:​navigation">Implementation of the navigation</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-FINDOLOGIC offers to integrate FINDOLOGIC with all the filters and search results in the shop navigation too. +[[integration_documentation:​parameters|Here]] you can find a description of common parameters used in a request to Findologic. 
-If you want to know more about this and how to integrate the navigation from FINDOLOGIC in your shop, just click [[integration_documentation:​navigation|here]].+
 ---- ----
  
-==== Smart Suggest customization ====+<​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:​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. + 
-You can also try out your changes live in this documentation. Click [[integration_documentation:customize_smart_suggest|here]] to get there.+[[https://​service.findologic.com/​ps/​centralized-frontend/​spec/​|Here]] you can find a detailed API specification of our JSON response format. 
 ---- ----
  
-==== Checklist ​for your own integration ====+<​html>​ 
 +    <​h3>​ 
 +        <a href="​https://​lisa.findologic.io/​v1/​ui/">​Li.S.A. response</​a>​ 
 +    </​h3>​ 
 +</​html>​ 
 + 
 + 
 +[[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:​checklist">Checklist for your own integration</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-If you are integrating by your own, we have made [[integration_documentation:​checklist|checklist]] ​for your integration\\ +You can download ​styleguide ​for your Li.S.A. ​integration ​as a PDF download {{ :​lisa_style_guide.pdf |here}}.
-and what you have to keep in mind, when using FINDOLOGIC (export, search result, configuration,​ etc.)+
  
 ---- ----
  
-==== Integration with plentymarkets (German) ====+<​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>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:​product_update_API">Product Update API</​a>​ 
-                <a href="​doku.php?​id=integration_documentation:​plentymarkets">Integration with plentymarkets (German)</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-Here you can find a detailed ​documentation how to integrate FINDOLOGIC with plentymarkets.+[[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>​ 
 +    <​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
  
 ---- ----
  
-==== Template manager ​====+===== 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=customer_account:template_manager">​Template manager</​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>​
  
-The template manager allows you to edit the search result pages to your desire.\\ 
-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]]. 
 ---- ----
  
-==== Template manager ​plugins ====+<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​api:​plentymarkets">​ 
 +            <img src="​https://​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​plenty_logo.png"​ style="​width:​50px;​margin-right:​10px">​ 
 +            Plentymarkets plugin integration 
 +        </​a>​ 
 +    </​h3>​ 
 +</​html>​ 
 + 
 +----
  
 <​html>​ <​html>​
-        <​div>​ +    ​<​h3>​ 
-            ​<​h3>​ +        <a href="​doku.php?​id=integration_documentation:plugin:en:​direct_integration:​shopify">​ 
-                <a href="​doku.php?​id=customer_account:template_manager:template_manager_plugins">​Template manager plugins</​a+            <img src="​https:​//​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:​plugins:​shopify_logo.png"​ style="​width:​50px;​margin-right:​10px"​> 
-            </h3+            Shopify app integration 
-        </div+        </a
-        <p>+    </h3>
 </​html>​ </​html>​
  
-FINDOLOGIC provides many template manager plugins for you, that make changes much easier+---- 
-[[customer_account:template_manager:template_manager_plugins|Here]] you can find everything regarding this topic.+ 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​plugin:​en:​integration:​shopware_5">​ 
 +            <​img src="​https://​docs.findologic.com/​lib/​exe/​fetch.php?​media=integration_documentation:plugins:​sw5_logo.png" style="​width:​50px;​margin-right:​10px">​ 
 +            Shopware 5 plugin integration 
 +        </​a>​ 
 +    </​h3>​ 
 +</​html>​
  
 ---- ----
  
-==== 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:​request">Request to 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>​
  
-The FINDOLOGIC search service is available after the first successful import-/​export process. ​ 
-[[integration_documentation:​request|Here]] you can find more about that topic. 
-\\ \\ 
  
 ---- ----
 +===== 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="doku.php?​id=integration_documentation:​response_xml">XML-response from FINDOLOGIC</​a>​ +    </h3>
-            </h3+
-        </​div>​ +
-        <p>+
 </​html>​ </​html>​
  
-The FINDOLOGIC search service is available after the first successful import-/​export process.  +Following ​the link above you can reach our API documentation.
-[[integration_documentation:​request|Here]] ​you can find more about that topic. +
-\\ \\+
  
-==== Frequently asked questions ​====+---- 
 + 
 +<​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. 
 +---- 
 + 
 +===== Checklist =====  
 + 
 +<​html>​ 
 +    <​h3>​ 
 +        <a href="​doku.php?​id=integration_documentation:​checklist">​Checklist for your own integration</​a>​ 
 +    </​h3>​ 
 +</​html>​ 
 + 
 +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.). ​
  
-//Note: Articles are currently only available in German// 
  
-[[https://​findologic.zendesk.com/​hc/​de/​articles/​219686867-Was-ist-der-Unterschied-zwischen-einer-API-Integration-und-der-Direct-Integration-|Was ist der Unterschied zwischen einer API Integration und der Direct Integration?​]]\\ 
-[[https://​findologic.zendesk.com/​hc/​de/​articles/​201781457-Was-ist-die-FINDOLOGIC-Navigation-|Was ist die FINDOLOGIC-Navigation?​]]\\ 
-[[https://​findologic.zendesk.com/​hc/​de/​articles/​201781027-Was-wird-als-verrechenbare-Suchanfrage-gewertet-|Was wird als verrechenbare Suchanfrage gewertet?]]