API Listeners

Another name for Utopia’s API generator. Create listeners to allow external systems to communicate with the Collections via a REST API endpoint. Instead of using a source connector to fetch data, allow data to get posted via an API or indeed Queried. Title: Give the listener a Title Active: Yes/No toggle – Mark the Listener on and off with this toggle Maintenance: Yes/No toggle – every interaction with these end points gets logged. This is useful during fault finding to find what configuration the external system is using if you are not connecting successfully, however it creates a lot of data. Use Maintenance to archive this information during the same System maintenance job described above.

Module: the listener module will describe how the end point interacts with the collection data.

The following pages will describe the different module types

Document Capture

Document Query (External)

Document Query (Internal)

You also can set your own header details and white list IP's from the Listener Security.