Submit a ticket

Self-Hosted API Configuration

Updated on Follow
0 out of 1 found this helpful
This setup is intended for self-hosted customers only. 
  1. Deploy to an API web environment.
    1. Establish a domain/URL for the API.
      • This can be hosted off the same web servers as the portals are located.

  2. Deploy to a web server on the WAN.
    1. Open Internet Information Services (IIS) Manager (%systemroot%\system32\inetsrv\iis.msc)
    2. Create IIS Application Pool
      1. Right-click on "Application Pools" in "Connections" pane on left-side
      2. Click "Add Application Pool..."
      3. Use the following recommended settings:
        • Name: Domain/url you established in step 1.a. above.
        • .NET CLR version: .NET CLR Versions v4.0.x
        • Managed pipeline mode: Integrated
        • Ensure "Start application pool immediately" is checked.

  3. Create IIS website with the following recommended settings
    1. Right-click on "Sites" folder in "Connections" pane on the left side.
    2. Click "Add Website..."
    3. Use the following recommended settings:
      • Site name: domain/URL established in step 2 above.
      • Physical path: C:\inetpub\wwwroot\{Use site name here}
        • Click ... button beside physical path and browse to C:\inetpub\wwwroot\
        • Click "Make New Folder" and name it the the same as your site name
        • Click OK
      • Binding:
        • Type: https
        • IP address: All Unassigned
        • Port: 443
        • Host name: domain/URL established in step 1.2.2 above.
        • Ensure "Start Website immediately" checkbox is unchecked.

  4. Add application to newly established API site
    1. Extract files from .zip release of Suite API to c:\inetpub\wwwroot\{Use site name here}\api
    2. Open "Sites" folder in the "Connections" pane on the left side.
    3. Right-click on API website.
    4. Click "Add Application..."
    5. Use the following recommended settings:
      • Alias: /api
      • Application pool: {Use site name here} (if this is not selected, click Select... and choose it in the dropdown)
      • Physical path: C:\inetpub\wwwroot\{Use site name here}\api

  5. Update the Web.config in C:\inetpub\wwwroot\{Use site name here}\api\Web.config to replace the following parameters:
    1. Replace any instance of "PLACE-YOUR-DATABASE-SERVER-HERE" with the fully qualified domain name of the database server (e.g. corpdevsql01.avionte.local) housing the target Avionté database.
    2. Replace any instance of "PLACE-YOUR-DATABASE-NAME-HERE" with the name of the target Avionté database (e.g. AvionteSuite
    3. Save the file.
      Note: In 13.2.x and 14.1, the connection string must use the supplied avionteweb credentials.
    4. Insert the URL pointing to the location of the installation of the Outlook Web Service into the Web.config file.
      1. Locate the Web.config file within the installation of Avionté
      2. On the line <add key="AvionteOutlookAddInWebService"... /> change the entered value to be the correct URL (e.g. "HTTPS://")

  6. Restart site and view it in browser at https://{site-url}/api -- if it's working correctly, it should return a 401 Not Authorized.

Have more questions? Submit a request


This space is for article feedback only. To make a request of the Avionté Support Team, please submit a ticket to