Allgemeine Parameter

Die folgenden Parameter müssen bzw. können bei jeder Übertragung übergeben werden.

Parameter		Beschreibung
id	benötigt	ID des Artikels für den eine Information gesendet werden soll. Wenn Sie mehrere ID-Felder benutzen (Produkt-ID, Varianten-ID, EAN, ISBN…), sprechen Sie bitte mit Omikron ab, welcher Wert hier übergeben werden soll.
masterId	benötigt wenn Deduplizierung verwendet wird	Sollten Sie in Ihrem Shop Artikelvarianten haben und die Varianten-Artikelnummer mit dem Parameter id übertragen, müssen Sie über diesen Parameter die Master-Artikelnummer übergeben, so dass die Produkte und möglichen Events einander zugeordnet werden können.
channel	benötigt	Der Name des FactFinder-Channels in dem gesucht wurde.
sid	benötigt	Hier übergeben Sie bitte eine Kennung für die Session des Users. Diese wird für die Logfileanalyse (Click-Through-Rate, Suchende zu Warenkorb-Rate, Conversion-Rate u.s.w.) benötigt. Wenn Sie die Personalisierung verwenden möchten, müssen Sie diesen Parameter für alle Tracking-Ereignisse, einschließlich der Suchanfragen angeben.
event	benötigt	Dieser Parameter gibt an um welchen Event es sich handelt. Benutzen Sie bitte für die unterschiedliche Typen folgende Werte: `click` – Klick auf das Produkt bzw. Sprung zur Detailseite. `cart` – Ablegen des Produktes in den Warenkorb. `checkout` – Kauf des Produktes. `login` – Benutzer-Anmeldung `recommendationClick` – Klick auf ein von der Recommendation-Engine vorgeschlagenes Produkt. `feedback` – Shop-Besucher-Kommentar zum Suchergebnis.
title	benötigt	Die Bezeichnung des Artikels. Dieser Wert ist optional, Sie können auch einen Leerstring übertragen oder den Parameter weglassen.
userId	benötigt	Hier übergeben Sie bitte eine Benutzerkennung. Diese muss, wie auch die Session-ID, anonymisiert werden. Die Benutzer-Kennung unterscheidet sich von der `sid` dadurch, dass sie bei wiederkehrenden Benutzern auch Session-übergreifend gleich bleibt. Die `userId` ist bei Einsatz des Personalisierungsmoduls beim Login-Event unbedingt erforderlich.

REST

Die technische Dokumentation der REST-API ist in der Suchanwendung selbst enthalten und kann über folgende URL aufgerufen werden:

Swagger Link

.../fact-finder

Beispiel: https://ng-demo.fact-finder.de/fact-finder/swagger-ui.html

Auf dieser Oberfläche erhalten Sie neben der Parameter-Dokumentation auch die Möglichkeit eine Abfrage zu testen und sich das Ergebnis davon anzuschauen. Da die Dokumentation mit Swagger erstellt worden ist, können sie mit Swagger Codegen einen Client dafür generieren und in Ihrem Code verwenden.

Die Dokumentation der Trackingschnittstelle befindet sich unter der Ressource tracking.