API Configuration - Public Sector Constituency Web Access - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Public Sector Constituency Web Access
Platform
OnBase
Product
Public Sector Constituency Web Access
Release
Foundation 24.1
License

The configuration of the Public Access API is similar to that of other .NET web applications: changes are made by editing a web.config file. This is an XML file that contains all API settings and, by default, resides in ..\wwwroot\PublicAccessServer\.

CAUTION: The Public Access API is a read-only public REST API which does not have an authentication mechanism and is externally accessible. The Public Access API has endpoints which are used for the front-end client JavaScript controls run from the user's browser. This means that users may access any data (including Keywords, Keyword Data Sets, and Document Types) within these endpoints without special permissions. When configuring settings within the Public Access API web.config file, ensure that no private data is made accessible through the API settings.

Settings in the web.config file can either be edited directly in a plain-text editor or by opening the file with the Web Application Management Console (WAMCon). In the sections that follow, WAMCon settings are listed with their corresponding web.config attributes. For more information on using WAMCon to edit the web.config file, see the Web Application Management Console documentation.

The following sections detail how to configure the Public Access API's web.config file:

Note:

At minimum, the Login Settings and Server Connection Settings must be configured in order for the Public Access API to communicate with the rest of the OnBase system.