The application includes a generic API that is accessed via a WCF web service which allows queries and data to be accessed outside the application. The API returns data in XML which can then be used by developers to allow data from the library database to be searched and displayed in an external application or website.
Documentation for use of the API is available by contacting the Soutron helpdesk.
To access System Configuration Maintenance, select System Management > System Configuration Maintenance.
Click on the API tab to display the page as follows:
This screen contains the following settings:
|Strict Mode||To run the API in debug mode, set the Strict Mode to Yes; this allows the search request parameters to be verified for validity. If they are not valid, an error will then be generated.||Yes|
|Default Page Size||This allows you to set the default number of records returned in a single page before you need to page through additional results pages using the page parameter (&page=1)||50|
|Show All CT in Search Result||No|
|Intellexer Summarizer API URL||Contact Soutron to discuss our Summarizer service|
|Intellexer Summarizer API Key||Contact Soutron to discuss our Summarizer service|
|Save search history||Save search history to database, useful for including API searches in search history reports||No|
|Save API Records Search Requests Log||Save API search requests to database for debug.||No|