Integration von Feedbackkampagnen
Mit Feedback-Kampagnen kann man Texte oder Produkte als „Feedback“ an den Shop zurückliefern lassen. Diese Kampagnen haben den flavour
FEEDBACK
.
Feedback-Texte
Frühere Versionen von FactFinder haben Platzhalter über Nummern verwaltet. Im Integrations-Projekt wurde definiert, an welcher Stelle der Shop-Seite welche Feedback-Text-Nummer erscheinen soll. Der Anwender wusste also, wenn er einen Feedback-Text mit der Nummer 3 anlegt, dann erscheint dieser Text beispielsweise über dem Suchergebnis[1]. Seit der Version 6.7 werden zudem Bezeichner für die Feedback-Texte hinterlegt und zurückgeliefert. Für aktuelle Integrationen soll der Bezeichner der Feedback-Texte als Identifikations-Merkmal verwendet werden.
Die Bezeichner werden während des Integrations-Projektes mit dem Shop-Betreiber vereinbart und in FactFinder konfiguriert. Der Anwender kann auf der Oberfläche zwischen den vordefinierten Bezeichnern wählen. Weiterhin wird für jeden Feedback-Text definiert, ob dieser HTML enthalten darf oder nicht. Dieses Merkmal wird ebenso von FactFinder zusammen mit dem Feedback-Text zurückgeliefert. Auf diese Weise ist es bei der Integration einfach zu entscheiden, ob der darzustellende Text html-escaped werden soll oder nicht[2].
REST
Die technische Dokumentation der REST-API ist in der Suchanwendung selbst enthalten und kann über folgende URL aufgerufen werden:
Swagger Link
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.
Zum Abruf verwenden Sie bitte die campaign
methode.
Pushed-Products
Für Feedback-Kampagnen können auch Produkte ausgewählt werden. FactFinder liefert die Produktliste zusammen mit der Kampagne zurück.
REST
Siehe Feedback-Texte.
[1] „Über dem Suchergebnis“ ist wirklich nur ein Beispiel. Die Position der Feedback-Texte wird vom Shop-Betreiber im Integrations-Projekt gewählt.
[2] Default-Wert für das HTML-Atrtibut ist false
. Fehlt das HTML-Attribut, bedeutet das, dass der Feedback-Text kein HTML enthält, er muss also escaped werden.