Set up the web server - Intergraph Smart 3D Web API - Installation & Upgrade - Hexagon

Intergraph Smart 3D and Smart 3D Admin Web API Installation and Configuration

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Installation & Upgrade
Smart 3D Version
13.1

To set up the web server for one of the APIs for Smart 3D, you use that API's Configuration Utility to provide information like website name and authorization provider.

  • The steps required to complete this task are almost identical for the two APIs, so the instructions are combined in this help.

  • The same IIS server can host both web APIs for Smart 3D. However, you must:

    • Configure each web API separately

    • Repeat these steps on each machine that acts as a web server.

  • Completing this task in the Configuration Utility does not complete the Web Server set up. Using other tools, you configure other parts of the environment like the application pool, web server file permissions, access claims, and app settings.

Security Recommendations

  • When a new site is created on IIS, make sure custom error pages are defined on it. This will make sure any request to this website does not show the platform information in response headers in case of an error scenario.

  • Enforce only TLS 1.2 on the web server.

  • Avoid configuring long token expiration times in the authorization server.

  • To avoid API replay attacks, such as someone trying to continuously burden the server with memory intensive requests, we recommend that you configure rate limiting for the APIs.

To get started

  1. If you are configuring the API for the first time on this machine, make sure all the prerequisites are installed.

    Before you can configure a web API on a machine, make sure that the following are already installed.

  2. Open the Configuration Utility for the web API you are configuring.

    1. Click Start > Intergraph Smart 3D.

    2. Choose the tool for the Web API you're configuring, either Web API Configuration Tool or Admin Web API Configuration Tool.

      The Configuration Utility opens to the Welcome page, which looks something like this.

  3. On the Configuration Utility's Welcome page, select Setup Web Server.

    The Configuration Utility checks to make sure everything is ready for you to configure the web server.

  4. Click Next, and continue: