Translations of this page:
 

FINDOLOGIC Integration for custom and unsupported ecommerce applications

The FINDOLOGIC integration does not have to be built from the ground up. Only the following components have to be integrated. Interface descriptions for every component are available

Item export

The items have to be exported in a custom CSV format made available through URLS in the store. These URLs will be called and the CSV will be download and imported by the FINDOLOGIC service. The format description and examples are available: CSV 2.0 format

Incremental export

If the export interface has to be called multiple times (e.g. due to a runtime limit of a PHP script; every call will export only a subset of the items, called a "page") the incremental export is used. In this case calling the export URL will provide a redirection to the next page using the HTTP location header. Calling the redirected URL will provide another redirection until all items are exported.

The URL has to accept a parameter that sets the number of items exported per page

The following output is possible in the response body of the script:

  • SUCCESS: Finished: The export finished correctly1)
  • SUCCESS: Unfinished: The export is not yet finished, a redirection to the next page is returned in the HTTP header
  • ERROR, human-readable output: An error was encountered. The error message may be provided in the output and will be sent to the store admin in a notification

After the export has successfully finished the CSV will be download from the given CSV-URL.

Example

Requests are sent by the FINDOLOGIC service, the response are generated by the store software

  1. Response (note the start value designating the next page):
    HTTP/1.1 302 Found
    Location: http://www.my-store.de/findologic_export.php?start=1000&limit=1000
    ...
    SUCCESS: Unfinished
  2. Response:
    HTTP/1.1 200 OK
    ...
    
    SUCCESS: Finished
  3. Export successfully finished, FINDOLOGIC will download the CSV

Search result integration

The store software will internally forward all of the customers' search requests to the FINDOLOGIC service. This is done transparently to the end user.

For the available request parameters see the documentation: search request

Result display

For the display of the results in the store several options are available.

Full HTML

For full HTML the FINDOLOGIC service will generate an HTML fragment which can be displayed in the store instead of the regular search results. The fragment contains all required components (facets, search results, pagination).

Layout and design can be customized using the FINDOLOGIC template manager.

HTML with IDs

Same as "Full HTML", but instead of fully rendered results only the item IDs will be returned. The item display will then be rendered by the store software using the same item templates as in the regular search results display.

This option is recommended over "Full HTML" as the display of the items is consistent with the rest of the store's design.

XML

All relevant result data (filter, items, pagination) is returned as XML, see XML 2.0

Module integration checklist

  • Item export
    • Item attributes and SKUs of item options / different models have to be summarized and exported with the main item
    • For multi-lingual stores an export has to be generated for the requested language by passing an URL-parameter (e.g. language=en for english)
    • The export is called by requesting a URL
    • The incremental export has to follow a defined process: inkrementelle Export
  • Search
    • The search has to support several search terms in one query
    • On the results page several filter options can be chosen simultaneously
    • Ensure that filters containing &, whitespace and accented characters are submitted correctly (UTF-8 + URL encoded)
    • For every configured language in the store a different FINDOLOGIC service has to be adressed
    • The request parameter identifier has to be passed through to FINDOLOGIC when searching
    • When the return format is XML or "HTML with IDs" a placeholder has to be displayed for unavailable items2)
    • When changing the page or item count3), currently selected filters, search terms and sorting have to be preserved
    • The userip4) has to be submitted to FINDOLOGIC
  • Output
    • Ensure that filters and queries with & and accented characters (Umlaute) are displayed correctly
    • Ensure that filters are not displayed when they do not change the result set (i.e. the current result set has 10 items, and the filter provides the same 10 items)
  • The item count can be changed on the results page
  • Available options for ordering the results
    • Deutsch: Beste Treffer, Günstigste zuerst, A-Z, Topseller zuerst, Neuheiten zuerst
    • English: Most relevant, Lowest price first, A-Z, Topseller first, Latest products first
  • The store ID (for multi-stores) has to be submitted to FINDOLOGIC
  • The modul has to ensure that crawlers / bots (ie. Google, Bing) do not crawl the search and FINDOLOGIC navigation
  • Landingpages: Redirecting to landingpages has to be supported
  • Promotions: Display of promotions has to be supported
  • Fallback mechanism
    • Phase 1: Alivetest
    • Phase 2: Search
  • Smart Suggest
    • Queries with &, whitespace and accented characters are submitted correctly
    • Preview images are displayed
    • The type of the suggested item is correctly displayed (category, vendor, item)
    • Search terms are highlighted
    • Suggestions can be chosen by click or return-key
    • When choosing a category / vendor suggestion the filter is set correctly for the search
    • The store ID is submitted correctly (for multi-stores)
    • For every language a different FINDOLOGIC service has to be adressed
  • Store-Backend
    • The FINDOLOGIC Service-URL and Shopkey can be set in the backend
    • The FINDOLOGIC logo can be chosen from the available options (Logos)
  • Misc
    • The FINDOLOGIC logo must be displayed if and only if the results are delivered from FINDOLOGIC
    • When searching with the URL parameter fallback=1 the default store search has to be used
    • A manual for installing the module has to be provided
1) If the export has only page
SUCCESS: Finished
can be returned directly
2) Item data in the FINDOLOGIC index is only updated periodically, so when an item is deleted between updates it cannot be displayed in the store; a placeholder makes this clear
3) number of items displayed per results page
4) IP of the customer currently searching
 
en/fl/integration/custom_unsupported.txt · Last modified: 2015/02/17 12:04 by johannes
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki