Interacting with jCustomer

November 11, 2022
Note: Marketing Factory is renamed to jExperience in version 1.11 and Apache Unomi is renamed to jCustomer. The 1.10 documentation has been updated to reflect the product name change.

There are essentially two modalities to interact with jCustomer, reflecting different types of jCustomer users: clients and integrators.

jCustomer clients are usually web applications or content management systems. They interact with jCustomer by providing raw, uninterpreted contextual data in the form of events and associated metadata. That contextual data is then processed by the context server to be fed to clients once actionable. In that sense context server clients are both consumers and producers of contextual data. Context server clients will mostly interact with jCustomer using the ContextServlet, requesting context for the current user and providing any triggered events along the way.

On the other hand, jCustomer integrators provide ways to feed more structured data to the context server either to integrate with third party services or to provide analysis of the uninterpreted data provided by context server clients. Such integration will mostly be done using jCustomer's API either directly using jCustomer plugins or via the provided REST APIs.

Below is the Unomi 1.5.0-snapshot REST API documentation. 
http://unomi.incubator.apache.org/rest-api-doc/index.html#home

Since jExperience uses a specific tag of jCustomer, it is possible that there are changes between the API documentation above and the version used by jExperience.