Abfrage von Produktempfehlungen per XML / JSON
Die Recommendation-Engine Empfehlungen lassen sich, wie das Suchergebnis auch, einfach über eine XML-Schnittstelle abfragen.
Um die Empfehlungen abzufragen rufen Sie bitte folgende URL auf:
$stringEscapeUtils.escapeHtml($body)
URL-Parameter
id=[Produkt-ID]
Über diesen Parameter übergeben Sie die Produkt-ID des Produktes, für das Sie Empfehlungen erhalten wollen. Wenn Sie mehrere IDs in ihren Daten haben (z.B.: Artikelnummer, Masterartikelnummer, EAN) fragen Sie am besten bei Ihrem Ansprechpartner nach, welche der IDs übergeben werden muss.
Sollten Sie die Verkaufsdaten über das Tracking importieren, so entspricht die Nummer der dort übergebenen Produkt-ID.
Dieser Parameter kann mehrmals angegeben werden, wenn Empfehlungen zu mehreren Referenz-Produkten generiert werden sollen:
$stringEscapeUtils.escapeHtml($body)
channel=[NAME]
Der Name des FACT-Finder Suchchannels, in dem sich die Produkte befinden. Wird der Parameter nicht übergeben, wird der Standardchannel verwendet.
sid=[SESSION-ID]
Hier übergeben Sie bitte eine Kennung für die Session des Users. Dies ist sowohl für die Erkennung des Benutzers notwendig, wenn Sie diesem personalisierte Empfehlungen ausspielen möchten, als auch für das FACT-Finder Tracking.
maxResults=[ANZAHL]
Mit diesem Parameter können Sie die gewünschte Anzahl der Empfehlungen übergeben. Falls der Parameter nicht übergeben wird, wird der Standardwert aus der Konfiguration verwendet.
idsOnly=[true|false]
Falls true als Wert übergeben wird, werden nur die Datensatz-IDs zurückgeliefert, was die Rückgabe schlanker macht. Sollten Sie die anderen Informationen der Rückgabe nicht benötigen erreichen Sie hierdurch eine verbesserte Performance.
XML-Rückgabe
Per Standard ist die Rückgabe der HTTP-Schnittstelle im XML-Format, Sie können dies auch explizit mit dem Parameter format=xml
anfordern. Das Rückgabeformat orientiert sich an dem des Suchergebnisses. Sie können daher hierfür unter Umständen denselben Parser verwenden.
Hier sehen Sie ein Beispiel für die Rückgabe, detaillierte Informationen finden Sie in der Suchintegrationsdokumentation.
<ff xsi:noNamespaceSchemaLocation="schema/7.2/ffrecommender.xsd">
<recommendationTimedOut>false</recommendationTimedOut>
<results count="10">
<record nr="0" id="7100-4851">
<field name="EAN">4008670221523</field>
<field name="Category">DVD</field>
...
</record>
...
</results>
</ff>
JSON-Rückgabe
Sollten Sie die Rückgabe der Schnittstelle im JSON-Format wünschen, so müssen Sie beim URL-Aufruf den Parameter format=json
mitgeben. Diese basiert ebenfalls auf der Suchergebnisrückgabe und liefert Ihnen eine Liste mit record
-Objekten.
Ein Schema der JSON-Rückgabe steht unter folgender URL zur Verfügung
$stringEscapeUtils.escapeHtml($body)
Ein Rückgabebeispiel sieht folgend aus:
[
"resultRecords" : [
{
"id": "ed6a4182...",
"record": {
...
}
},
...
],
"timedOut": false
]