Ändern, Löschen und Hinzufügen von Datensätzen
Über diese Schnittstelle lassen sich einzelne oder mehrere Datensätze in der Suchdatenbank aktualisieren, löschen oder hinzufügen. Es ist jedoch zu beachten, dass bei einem Datenimport die über diese Schnittstelle gemachten Änderungen verloren gehen. Als Importgrundlage werden immer die zur Verfügung stehenden Produktexportdaten Ihres Systems verwendet. Verwenden Sie diese Schnittstelle also nur, um temporär mal schnell einen Datensatz zu korrigieren.
Alle Änderungen sind sofort in der Suche verfügbar. Indem Sie die Datenbank speichern, werden die gemachten Änderungen auf die Festplatte geschrieben, sodass die Änderungen auch nach einem Serverneustart verfügbar sind. Der Speichervorgang benötigt jedoch Rechenleistung, sodass dies nicht bei jedem Änderungsaufruf ausgeführt werden sollte.
REST-Schnittstelle
Mit FACT-Finder 7.3 ist eine REST-API hinzugekommen. Die technische Dokumentation von dieser ist in der Suchanwendung selbst enthalten und kann über folgende URL aufgerufen werden:
$stringEscapeUtils.escapeHtml($body)
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 Methoden sind unter dem Punkt records
dokumentiert.
HTTP-Schnittstelle
Jede der Aktualisierungs-Methoden wird über eine andere URL angesprochen:
$stringEscapeUtils.escapeHtml($body)
Über den Parameter id
müssen Sie die Datensatz-ID des Datensatzes angeben, der entweder gelöscht oder aktualisiert werden soll. Bei einem neuen Artikel wird über diesen Parameter die ID in der Datenbank festgelegt.
Wenn Sie einen Artikel aktualisieren oder anlegen, so müssen Sie dessen Felder als Parameter übergeben. Der Parametername ist hierbei der Feldname, und der Parameterwert ist der zugehörige Feldwert.
Wird zudem save=true
als Parameter übergeben, so wird die Datenbank nach der Änderung gespeichert. Ohne die Persistierung der Datenbank würden die Änderungen bei einem Server- oder Anwendungsneustart verloren gehen. Bitte beachten Sie jedoch, dass während des Speicherns der Datenbank keine Suchen ausgeführt werden können, was zu Verzögerungen im Suchablauf führen kann. Wir empfehlen daher den Parameter nicht bei jedem Aufruf mitzugeben, sondern die Übergabe abhängig von der Zeit oder der Anzahl gemachter Änderungen zu definieren.
Webservice/SOAP-Schnittstelle
End of Life
Bitte beachten Sie, dass die SOAP-Schnittstelle nicht mehr erweitert oder aktualisiert wird und mittelfristig entfällt. Wir empfehlen Kunden bei einer Neuintegration diese nicht und stattdessen die REST-API zu verwenden. Sollten Sie bisher die SOAP-Schittstelle verwendet haben, können Sie diese noch weiterhin nutzen, wir empfehlen aber auch hier die Integrationsschnittstelle zu ändern, um von den Vorteilen der anderen Schnittstellen, wie eine schnellere Übertragung und somit Geschwindigkeit, zu profitieren.
Die WSDL dieser Schnittstelle ist identisch mit der der Importschnittstelle, jedoch werden hierfür die Methoden insertRecord
, insertRecords
, deleteRecord
, deleteRecords
und updateRecord
verwendet.
Allen Methoden werden der Channelname, die Logindaten und das Speichern-Flag übergeben. Den Löschen-Methoden wird zudem entweder eine ID oder eine Liste mit IDs übergeben, die ebenfalls gelöscht werden sollen. Die Aktualisierungs- und Hinzufügenmethoden haben weiterhin ein bzw. mehrere ImportRecord
-Objekte.