For the complete documentation index, see llms.txt. This page is also available as Markdown.

Optional Interfaces

Use optional interfaces for record updates, imports, and other advanced integration workflows.

Summary

This article covers additional optional interfaces. You do not always need them, but they are useful in many integration setups.

Documentation for individual FactFinder modules, such as Campaign Manager and Recommendation Engine, is available in separate articles.

Make sure the user account you use for authentication has the required rights. Otherwise, the request returns an error.

Changing, deleting and adding records / delta updates

This interface lets you update, delete, or add individual records or batches of records in the search database.

Changes made through this interface may be overwritten by the next data import.

The product data export from your shop system remains the basis for imports. Use this interface mainly for temporary fixes or quick corrections.

Changes are available in search immediately. When you save the database, the changes are written to disk and remain available after a restart. Saving requires processing power, so it should not be done after every single change request.

Important:

  • Only send actual data changes to FactFinder.

  • Queue updates and send multiple changes in one request whenever possible.

  • Use delta updates for incremental changes, and keep a regular daily csv import as your baseline.

Updating databases

In most cases, FactFinder handles data updates itself. In some setups, however, the import is not started by FactFinder but through the Import interface. This is especially useful when data is provided with the Push method.

If the FactFinder Search configuration includes a URL for the export data, FactFinder can download the data before starting the import.

REST-Interface

The REST API documentation is part of the search application and is available at [your NG server]/fact-finder/swagger-ui.html. You can also access it here:

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

The relevant methods are documented under records. In addition to parameter documentation, you can test requests and inspect the results directly. Because the documentation is built with Swagger, you can also use Swagger Codegen to generate a client for your code.

Last updated

Was this helpful?