Configuring InternalApi - On Premises R2020

On-premises requirements, installation, and upgrade guide

  • To configure the InternalApi application to connect to your library:
  1. Open the C:\inetpub\wwwroot\ folder.
  2. In the InternalApi folder, open the ApiServer.config file in a text editor such as Notepad.
  3. In the <Libraries> section, add a new line for the library that you want to connect to. Use the commented examples as a guide for the required information.

    There are two ways of connecting to the SQL Server: “trusted” or “fixed”:

    • A trusted connection means that the user for the Application Pool Identity logs in to the SQL Server. For this type of connection, “Windows Authentication” must be enabled on the SQL Server, and the Application Pool Identity User must be allowed full control over the selected database.

      Example for a trusted connection:

      <Library Alias="SampleTrusted1" Type="SqlServer" Server=".\SQLEXPRESS" Database="SampleTrusted1" TrustedConnection="True" />

    • When using a fixed SQL Server login, there must be a dedicated user-login on the SQL Server that has full access to the selected database. The username and password of this SQL Server user must be specified in the connection settings.

      Example using a fixed SQL Server login:

      <Library Alias="SampleFixed2" Type="SqlServer" Server=".\SQLEXPRESS" Database="SampleFixed2" TrustedConnection="False" LoginID="SqlUser" Password="SqlPassword" />

      In which:

      Library Alias:is  the name of the library to be used. This should also match the database name.

      Type: should be “SqlServer”

      Server: network name or ip address of the SQL Server

      Database: name of the library on the SQL Server


      True” if you are using the Application Pool Identity User to log into SQL-Server using Windows authentication.

      False” if you want to use a fixed SQL Server login such as ait to connect to the database.

      LoginID: Name for the fixed SQL Server login.

      Password: password for the fixed SQL Server login.

  4. Save and close the config file.