Support Home
Print Article

InterAction On-Premise API (InterAction+)

Document ID

Document ID PR1672

Product

  • InterAction®

Category

  • N/A

Was this helpful?

Submitting...
Thank You!
There was an error with your submission. Please try again.
Article Content

InterAction On-Premise API

The InterAction On-Premise API is a secure gateway used by InterAction+ applications (InterAction 365, client insights, InterAction Mobile app) to securely connect to your InterAction environment. This version of the InterAction On-Premise API can be installed and used with version 6.2, and higher of InterAction. We strongly recommend that you apply updates to the InterAction On-Premise API regularly in order to take advantage of all features and functionality. Refer to the release notes at the bottom of the page for more information.




Version 8.x Requirements

  • IADB_Patch_Release_22_009.sql or higher.
  • On-premise API server utilizing Docker on Linux or MSI on Windows Server 2016 or Windows Server 2019 or Windows Server 2022
  • Reverse Proxy or Load Balancer
  • SAML 2.0 Federation


See the InterAction+ Deployment document for more details.



Version 7.x Requirements

  • Database Update 02_001, or higher
  • On-premise API server utilizing Docker on Linux or MSI on Windows Server 2016 or Windows Server 2019 or Windows Server 2022
  • Reverse Proxy or Load Balancer
  • SAML 2.0 Federation

See the InterAction InterAction+ Deployment document for more details.




Version 6.3 Requirements

  • Database Update 10_001, or higher 
  • On-premise API server utilizing Docker on Linux or MSI on Windows Server 2016 or Windows Server 2019
  • Reverse Proxy or Load Balancer
  • SAML 2.0 Federation

See the InterAction+ Deployment document for more details.



Version 6.2 Requirements
  • Database Update 76_001, or higher
  • On-premise API server utilizing Docker on Linux or MSI on Windows Server 2016 or Windows Server 2019
  • Reverse Proxy or Load Balancer
  • SAML 2.0 Federation


 See the InterAction+ Deployment document for more details.





Documentation



Installation Instructions

The LexisNexis InterAction team will help customers with the initial installation of the InterAction On-Premise API service as part of completing the setup to begin using InterAction 365 and client insights. The following installation instructions are to be followed for upgrading the existing InterAction On-Premise API to the latest version specifically where the InterAction On-Premise API is installed on Windows Server (Note: If you have the InterAction On-Premise API installed on Linux, you will automatically receive the latest API updates).

1. Download the latest InterAction On-Premise API using the link below and save the file. Unzip the file in a directory that has been created on the hard drive directly off the root of the drive (to ensure the path is a short path) such as [drive]:\IAUpdates 
2. Save a copy of the current appsettings.json file located in the following directory on the server where the InterAction On-Premise API is installed: [drive]:\Program Files\LexisNexis\InterAction On-Premise API
3. Un-install InterAction On-Premise API in the Control Panel.
4. Double-click InterAction On-Premise API Setup.msi in the directory where you unzipped the file to begin the installation.

Notes:
  • You will be prompted to enter values for Auth Url and AppServer Url during installation. Refer to the saved appsettings.json file for these two URL values. For Auth Url, enter the value for AuthorityUrl from the appsettings.json file. For AppServer Url, enter the value for ServerUrl from the appsettings.json file.
  • Leave the option "Use enhanced database connection" un-checked.


5. Open the appsettings.json file in the following directory: [install drive]:\Program Files\LexisNexis\InterAction On-Premise API
6. Find the following section at the very beginning of the file:

{
  "DatabaseSettings": {
    "ConnectionString": "",
    "UseEnhancedDbConnection": "false"
 },

7. Copy and paste the following information inside of the parenthesis ("") for the ConnectionString:

Server=DbServer,DbPort;Initial Catalog=DbName;Connection Timeout=30;Application Name=IA On-Premise API;Integrated Security=False;

8. Make the following changes to the information inside of the parenthesis ("") for the ConnectionString:
  • Change DBServer to the SQL Server where your InterAction database is installed.
  • Change DbPort to the appropriate port number where the InterAction database can be accessed.
  • Change DbName to the name of your InterAction database.

Here is an example of a database called InterAction installed on a server called LNGOAKIADB and accessed on port 1433:

{
  "DatabaseSettings": {
    "ConnectionString": "Server=LNGOAKIADB,1433;Initial Catalog=InterAction;Connection Timeout=30;Application Name=IA On-Premise API;Integrated Security=False;",
    "UseEnhancedDbConnection": "false"
  },

9. Save the change. 

Proceed to step 14, if the InterAction On-Premise API service was not previously configured for HTTPS. This can be confirmed in the appsettings.json file that you saved in step 2. The Kestrel section at the end of the file will look like this if the InterAction On-Premise API was not configured for HTTPS:



Steps 10-13 are only required after the API is installed, if the InterAction On-Premise API service was previously configured for HTTPS. The Url in the Kestrel section of the saved appsettings.json file will show Https and will also contain an entry for Certificates below Kestrel.

10. Open the appsettings.json file saved in step 2.
11. Copy all of the information starting with "Kestrel": { through the rest of the file.
12. Open the appsettings.json file in the following directory: [install drive]:\Program Files\LexisNexis\InterAction On-Premise API
13. Select all of the information starting with "Kestrel": { through the rest of the file, and paste in the copied information. Save the change.
14. Stop and start the InterAction On-Premise API in Services.
15. Test InterAction On-Premise API connectivity by using one of the following URLs from a browser directly on the API server:


Note: The API is configured to use port 5123 by default. If the API was setup to use a different port, the Url in the appsettings.json file will be different and will need to be used in the test URLs noted below (in place of "5123"). If no port is referenced, and HTTPS is being used, then the API is configured to use port 443 and no port needs to be specified in the HTTPS test URLs below.


- If the API is configured for HTTP: http://localhost:5123/status
- If the API is configured for HTTPS: https://localhost:5123/status


You can also test InterAction On-Premise API connectivity by using one of the following URLs from a browser directly on the API server:

- If the API is configured for HTTP: http://localhost:5123/api/status
- If the API is configured for HTTPS: https://localhost:5123/api/status



The InterAction App Server, Authentication Server and Database Server should all return OK:







Download
InterAction On-Premise API v.1.3.2311.2828.zip





Update History
 


December 14, 2023 - 1.3.2311.2828
  • This version of the API has been modified to not allow the "Enable new Appointment Sync with Outlook Calendar" feature in CIM to be enabled, if IADB_Patch_Release_23_011 (or higher) has not been applied to the InterAction database. IADB_Patch_Release_23_011 included a fix to a stored procedure in the Database Maintenance process that was deleting activities created by the calendar-sync feature in Client Insights (CIM) after 30 days.


September 21, 2023 - 1.3.2309.803
  • Profiles may not load within client insights (CIM) due to a high volume of folder-specific additional fields. Changes have been made to the Application Server and InterAction On-Premise API to fetch the additional fields more efficiently*. (264073) 
  • Users with a Data Governance license in CIM can now**:
- Create and edit Marketing Lists
- Add, remove, edit access rights on Marketing Lists
- Add, remove and edit additional fields on Marketing Lists
 
* Application Server v8.01.10 (or higher), or v7.01.21 (or higher) is also required.
** Application Server v8.01.05 or higher is also required.
 

June 15, 2023 - 1.3.2305.3002
  • Changes to support the InterAction Home Dashboard page within Client Insights*.
* IA_DB_Patch_Release_23_006 or higher is required.


April 20, 2023 - 1.3.2304.602
  • Changes to support future functionality.
  • In CIM, some user contacts appear while viewing "My Contacts not on This List" within a sponsored list*. (211534) (6129)

    *The following Database Update is required if you are not on version 8 of InterAction:

    Version 7: IA70_Patch_Release_13_001.sql or higher
    Version 6.3: IA63_Patch_Release_16_001.sql or higher
    Version 6.2: IA62_Patch_Release_80_001.sql or higher

Note: API Update 1.3.2304.602, or higher, is required for users with a Data Governance license to have the ability to delete firm contacts within Client Insights which was a feature enabled as part of our 23M05 release on May 18, 2023. This feature to delete firm contacts also requires IA_DB_Patch_Release_23_004, or higher.


January 19, 2023 - 1.3.2301.902
  • Changes to support the new calendar sync that can be used to automatically add calendar items to InterAction*.
  • Changes to support Hyperlink custom fields for Pipeline Management within Client Insights**. (233735)
  • Allow users the ability to delete Initiatives within Client Insights***. (226242)

* IA_DB_Patch_Release_22_009 or higher is required.
** IA_DB_Patch_Release_23_001 or higher is also required.
*** IA_DB_Patch_Release_22_011 or higher is also required.



Click here for issues resolved in previous InterAction On-Premise API updates.
Recommendation
Submitting...