integration_documentation:other_shopsystems

integration_documentation:other_shopsystems

This is an old revision of the document!


FINDOLOGIC installation instructions for in-house/individual shop systems

In the following you will learn how to integrate FINDOLOGIC into your shop system in just a few steps. The components that need to be adjusted / developed for the FINDOLOGIC search involve:

To enable FINOLOGIC to index the item data, it is first necessary to export the item data.

To do so, the following steps are required:

1.1 Interface

  • To start the export, create an interface that is externally callable.

1.2 Export

  • Export your item data such as item ID, description, price, attributes, etc. into an externally accessible CSV file or via XML export.

Documentation

The export can be in CSV or XML format.

For an exact description of the export and the CSV format, please visit the following links:

Click here for CSV Export documentation
Click here for CSV Format description

For an exact description of the export and the XML format, please visit the following links:

Click here for XML Export documentation
Click here for XML Format description

To send a query to FINDOLOGIC, a corresponding HTTP request must be sent to FINDOLOGIC.
This corresponds to a simple defined structure with the following parameters.

To do so, the following steps are required:

2.1 Structure of the request URL

  • The request URL is comprised of the specified path to the service and the corresponding search parameters.
  • The request parameters communicate the exact query to FINDOLOGIC.
2.1.1 Transmitting the search terms
  • The search terms are transmitted to FINDOLOGIC with the query parameter.
2.1.2 Transmitting the attributes
  • The search results can be refined with the help of attributes, category, vendor or price.
  • The respective restrictions are transmitted to FINDOLOGIC by means of an attrib parameter
2.1.3 Transmitting the sorting
  • By default, the search results of FINDOLOGIC are sorted according to the optimal relevance.
  • User sorting preferences can be indicated using the order parameter.
2.1.4 Transmitting the shopkey
  • A key supplied by FINDOLOGIC defines the service (shop) to be searched.
  • This is transmitted by means of the shopkey parameter.
2.1.5 Transmitting other parameters
  • In addition, parameters for determining the number of results, the offset or the requesting user IP must be transmitted.

2.2 Creating a fallback mechanism

  • If the FINDOLOGIC search should not be accessible, the conventional shop search must process the query.
  • For this purpose, you need only first check the accessibility by means of a defined Alivetest (see documentation) and, if necessary, forward the query to the conventional shop search.

Documentation

For an exact description of the search request, please visit the following link:

Click here for documentation of the request

FINDOLOGIC may respond to a query in XML or HTML format (supported by Smarty templates).
To implement new modules, we recommend the use of the XML format.

3.a XML response

The XML response consists of information on the query, the search results, possible filter values and information on special output formats (landing page, promotion).

3.a.1 Processing search results

  • The search results are transmitted as product IDs. For the presentation, usually existing templates are used to output the corresponding products.

3.a.2 Refining filter values

  • To offer the user filter options, the returned filters and filter values must be transformed (rendered) into an HTML display.

3.a.3 Support of additional features (special output formats)

  • For landing pages, the user merely needs to forward to a given URL.
  • For promotions, the given image with the link must be output via the search results (or to any suitable location).

3.b HTML response

Smarty templates are used with the HTML response.
To adapt the templates, FINDOLOGIC offers its customers a template manager in the FINDOLOGIC customer account.
All offered Smarty variables can be found in the documentation listed below.
For our templates, we also offer a series of plugins which simplify the design of the templates for you considerably.

3.b.1 Output of search results

  • Item output can be adjusted using Smarty templates in the FINDOLOGIC customer account.
  • However, FINDOLOGIC recommends that the user only have the IDs output via the templates and to display the item listings with the help of existing shop templates.

3.b.2 Output of filters

  • Filter output can be adjusted as desired in the templates.

3.b.3 Support of additional features (special output formats)

  • Landing pages and promotions can also be adjusted directly via the Smarty templates in the FINDOLOGIC customer account.

Documentation

For an exact description of response formats, please visit the following links:

Click here for a description of the XML format
Click here for a description of templates
Click here for documentation of the template plugins

Of course, Smart Suggest is also part of the range of functions of FINDOLOGIC.
The Smart Suggest function is completely provided by FINDOLOGIC. Only a few steps are necessary to embed it into the shop.
The behaviour of Smart Suggest can also be adjusted manually as desired.

To do so, the following steps are required:

4.1 Integrating the script tag

  • To embed Smart Suggest, you need only integrate a script tag provided by FINDOLOGIC into the shop page.

4.2 Uploading the Smart Suggest proxy

  • You will also upload a pre-made PHP file into your shop directory.

4.3 Settings

  • You can adjust the settings of Smart Suggest in your FINDOLOGIC customer account.

4.4 Implementation

  • No further implementation is required for Smart Suggest!

Documentation

For detailed documentation of FINDOLOGIC Smart Suggest, please visit the following links:

Click here for embedding Smart Suggest
Click here for configuring Smart Suggest in the FINDOLOGIC customer account.

FINDOLOGIC Navigation enables the customer to find the desired item intuitively at any location in the shop - completely independently of the use of the search function!

To do so, the following steps are required:

5.1 Transmit category to FINDOLOGIC

  • When a customer navigates into a category, a query is sent to FINDOLOGIC.

5.2 Display filter and search results

  • The response is processed in accordance with the procedure described in item 3

Documentation

For detailed documentation on FINDOLOGIC please visit the following link:

Click here for Implementation guide for navigation

The checklist provides a helpful basis for dealing with all necessary points step by step for implementation as well.
BPlease check whether all the checklist point requirements have been met before completion!

Click here for the Checklist