Changes
Added images
In detail, the service consists of three major parts:
* Web Service
** Customizable Authentication SystemMechanism* Customizable Import SystemMechanism
== Web Service ==
If you want to develop an interface to get data from your 3rd party system to Ubik, you might want to consider using this system as well. It's easy to set up and requires minimal configuration on the Ubik side.
== Authentication System Mechanism==[[File:AuthenticationMechanism.png|thumb|Authentication Mechanism]]
There is currently no default implementation, so in order to get the Web Service running, one plugin containing a custom <code>ImportValidator</code> has to be provided.
It contains a single method to override, <code>Validate</code>, which contains the headers of the incoming requests to validate the Authorization header. There is also a possibility to set the outgoing headers for the response, for example, to return a token that makes authentication easier next time.
== Import System Mechanism==[[File:ImportMechanism.png|thumb|Import Mechanism]]The Import System Mechanism is the heart of the entire system. It is responsible for creating Ubik objects out of raw data, via proxies.
In its ideal use case, the interface runs the following steps:
