Endpoints
Last updated
Last updated
A brief overview of the functionality and concepts.
The main endpoint is the Document endpoint /docs . This endpoint allows you to manage data in the form of documents, often using a format like JSON, BSON, or XML. It is a schema-less data storage, which is useful for applications that need to "park" data for some time, like status', or information which is required only for the life-time of a business or an import process, for example.
The Template & Render Engine is a powerful reporting engine, based on Apache's /templates.
Especially with Boomi Integration this endpoint can simply solve many requirements:
Render formatted E-Mails with information from the current process.
Create HTML templates with placeholders and fill the out using data from the process.
Create (signed) PDF documents from the rendered HTML. (Required additional libraries.)
Turn your process data into any kind of "readable" document:
Print invoices
Create order forms
...
In combination with Documents where you can store the rendered document, this is the perfect fit!
The Mirror /mirror endpoint does not have much functionality: It simply responds what you requested, and it logs the request incl. header and body as a Document - for a couple of minutes.
The intention was to visualize what your service client is sending if you do not have too much control over the client.
With Boomi Integration, for example, you cannot visualize what you are sending. If you receive weird responses, you may want to redirect your Boomi request to the Mirror endpoint to see what you sent.