Summary
This article contains information about additional optional interfaces that can be used. It is not always necessary to use one of these, but in many cases it makes sense to do so.
Documentation for individual FactFinder modules (such as the Campaign Manager, or the Recommendation Engine) is found in individual articles.
Please make sure that the user you use for authentication purposes when sending requests to this interface holds the relevant rights. You will receive an error message if this is not the case.
Changing, deleting and adding records / delta updates
This interface allows individual or multiple records in the search database to be updated, deleted or added.
It should be noted, however, that changes may be lost when a data import is performed via this interface.
The product data export provided by a shop system is always used as the basis of the import. Therefore only use this interface temporarily to make a quick correction to a record.
All changes are immediately available in the search. By saving the database the changes made will be written to the hard drive, so that the changes will also be available after a restart. The saving process requires processing power, however, so it should not be carried out for every change call.
important
Only send data changes to FactFinder. Do not send updates to values where no change has occurred.
Queue updates and send multiple updates in one request. Bulk updates are preferred to multiple smaller updates.
Use delta updates (that is: change, delete and add records) to make incremental changes to data held by FactFinder. It is advised that a daily
csv
import is also provided.
Updating databases
In most cases FactFinder handles data updates itself. However, depending on the definition of the update process, the import will not be initiated by FactFinder itself, but via the Import interface. This makes sense especially if the data is provided using the Push method.
If a URL from which the export data can be drawn is stored in the FactFinder Search configuration, it is possible to download this before the import, so that it can be loaded.
REST-Interface
The technical documentation of the REST-API is contained in the search application itself and can be accessed via [your NG server]/fact-finder/swagger-ui.html . It can be also accessed via the following URL:
Swagger Link
Methods are documented under records
. In addition to viewing the parameter documentation, you can also test a query and view the results. The documentation was created with Swagger, so you can use Swagger Codegen to generate a client to use in your code.