Documentation for a newer release is available. View Latest

Integration

The current integration patterns supported for the three core components that make up the solution are:

  1. embedded

  2. expose HTTP API + client library

  3. expose HTTP API + custom API consumer

Embedded

To embed one of the components into an application you typically follow three steps:

  1. declare the dependency in your pom.xml

  2. define any Spring Beans that may be required

  3. configure

Each of these steps are described in the individual component 'getting-started' documentation.

Expose and Use HTTP API

Each of the core components in this solution have the option to expose an HTTP API. The steps to set this up are described in the individual component documentation.

Client Library

To interact with the HTTP API exposed for each of the core components, there is a client library provided. The steps to set this up are described in the individual component documentation.

Custom API Consumer

Instead of using the client library, you can create your own custom API consumer. You will need to refer to the API documentation of each of the core components to develop your own consumer: