Admin: RPI Integration API Installation

Overview

The RPI Integration API provides a series of endpoints that allow for a third party development team to invoke RPI functionality.  The following section describes installation of the RPI Integration API.

Prerequisites

• Microsoft .NET  Framework 4.8

• IIS Configured with the following options o Static Content Compression o Dynamic Content Compression

  • http://ASP.NET 4.6

  • Application Initialization

  • WebSocket Protocol

    

• IIS URL Rewrite 2.1 -https://www.iis.net/downloads/microsoft/url-rewrite

Integration API Installation

1. Create an ‘integrationapi’ directory in the root of the RPI web application.

   

2. Copy the contents of API-Deployment-Files.zip to the integationapi directory.

3. Modify the ACL properties for the App_Logs and App_Temp folders to allow “Full Control” for the ”Network Service” user.

   

4. Convert the integationapi directory to an IIS Application.

   

5. Select an Application Pool configured to run under the NetworkService Identity for the Integration API application.

   

   

6. The Integration API database connection string is configured to use SQL Server Integrated Security. This connection string must match the Redpoint Interaction connection sting. Connection strings are configured in the ConnectionStrings.config file in the App_Config directory at the root of the integrationapi directory.

   

7. Navigate to the new Integration API application in a web browser to confirm your installation.

   

Integration API User Group

User accounts that require access to the Integration API must be assigned to the Integration API user group. User group assignment can be undertaken in the Server Workbench Clients tab.

API users that require access to the Integration API cluster endpoints will require the Cluster administrator permission, which can be managed in the same context.