Integrating FACT-Finder Search via Webservice / SOAP

We don’t recommend using this interface for querying search requests because search performance – or more precisely: the time until results are delivered - plays an important role in eCommerce.

Please refer to the corresponding notes on the comparison between different intergration variants.

End of Life

Please note: the SOAP interface will no longer be updated or upgraded. We recommend the REST-API for new customers. If you have been using the SOAP interface so far, you can go on using it. We do however recommend changing your integration interface to improve performance.

The endpoint for the SOAP interface is at:

$stringEscapeUtils.escapeHtml($body)

This documentation should make it clear how to use the interface. No sample code or implementation detail is shown here, but we will be happy to send you sample implementations as well as a JavaDoc.

Sending the search query

The method getResult is provided to query a search result.

This method has parameters that comprise the search parameters in the form of a Params object, and an AuthenticationToken object with which you must pass login data. The AuthenticationToken object must set the username, timestamp and encrypted password as described above.

The settings for the search query are set in the Params object using simple setter methods. For the filters, it should be noted that if you want to allow selection of multiple elements in a field, you must first set multiple FilterValue objects in the appropriate Filter objects and then add this to the parameters.

If you want to send special parameters to FACT-Finder so that a custom solution can be implemented, please set these using the customParameters. Moreover, these cases should be discussed in detail with an Omikron consultant.

Please do not forget to provide a session ID in the TrackingInformation. This is obligatory if you are using the Personalization module. Apart from that, it allows detailed analysis and automatic optimization.

Processing results

In response to the aforementioned methods being called, the server will return a Result object. This contains all the search results information you need to display the data to your users.
The status information is among the most important data in the search result. This indicates whether a search result was found and whether an article number search was carried out. Based on this you can decide what results page to show the user. The search results of type SearchRecord are saved in a list and can be displayed accordingly. These objects contain all fields saved in the FACT-Finder database; they can be queried using getRecord().

Please consult the XML integration description or the JavaDoc for a detailed description of the information.

Page Contents