User login

If you are using the Personalization module you have to let FactFinder know which session is connected to which user. In order to do this, you have to send a login event whenever a user logs in into your shop.

Parameter		Description
sid	essential	Use this to pass the user’s session identifier. This is only needed in order to connect the session to the user and must be anonymised.
userId	essential	Use this to pass a user identifier. Like the session ID, this must be anonymised. The user identifier differs from the sid in that it remains the same for users who visit more than once. Use of this parameter is mandatory for this event. In case your shop does not require a permanent user account, you have to provide an alternative as the user ID that has a longer life span than a session (like a cookie ID) in order to allow personalization to re-use its learnings in the user’s next shopping session. It is also possible to first assign the session to the cookie using the login event and once the user ID is known re-assign the session to the user. Then the session learnings will first be merged with the cookie learnings and later everything will be merged with the user learnings.

Parameter

Description

sid

essential

Use this to pass the user’s session identifier. This is only needed in order to connect the session to the user and must be anonymised.

userId

essential

Use this to pass a user identifier. Like the session ID, this must be anonymised. The user identifier differs from the sid in that it remains the same for users who visit more than once. Use of this parameter is mandatory for this event.

In case your shop does not require a permanent user account, you have to provide an alternative as the user ID that has a longer life span than a session (like a cookie ID) in order to allow personalization to re-use its learnings in the user’s next shopping session. It is also possible to first assign the session to the cookie using the login event and once the user ID is known re-assign the session to the user. Then the session learnings will first be merged with the cookie learnings and later everything will be merged with the user learnings.

REST

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
https://ng-demo.fact-finder.de/fact-finder/swagger-ui.html

The interface offers not only the parameter documentation, but also the option to test a query and review the result. The documentation was created with Swagger, you can use Swagger Codegen to generate a client for it and use it for your code.