Configure the installed Smart Instrumentation server - Intergraph Smart Instrumentation - 2.3.15 - Installation & Upgrade

Intergraph Smart Instrumentation Web API Installation and Configuration Guide
ft:locale
en-US
Product
Intergraph Smart Instrumentation
Subproduct
Web API
Search by Category
Installation & Upgrade
Smart Instrumentation Web Version
2.3

The following procedure for configuring Smart Instrumentation Web API server to your site and authenticate your user credentials requires that you edit certain values in the Web.config file using a text editor such as Notepad++.

Intergraph Smart API Manager is being used as the Oauth provider. If you are using another authorization/authentication application, there might be some differences in the settings. Check with the documentation of the software you are using.

To connect the IIS based Web API to Smart Instrumentation, do the following:

SHARED Tip You should make a copy of the Web.config file before making changes.

  1. Navigate to the Smart Instrumentation installation folder, by default C:/Program Files (x86)/SmartPlant/Instrumentation/Web Services/SI WEB API <version number>.

  2. Locate the Web.config file and open it in a text editor of your choice.

  3. In the open text document, find the <intergraph.webApi> section. Use the table below to update the attributes displayed in the first column with their values shown in the third column.

    Section

    Look for:

    Add the following strings in between the " "

    <services>

    BaseURL =

    Update the FQDN server name, for example: https://Name.Domain.com

    id=

    Change to the following temporary identifier: 77FB732E-463F-4358-A04C-E2AD3620D354

    secret =

    Change to the following temporary secret:
    samAPISecret

    <security>

    oauth_issuer=

    Update with the SAM Issuer URI

    requiredScopes=

    By default, this is "ingr.api"

    <documentation>

    Swagger_Client_Identifier =

    F3D38862-81F2-4839-A774-B76C351BD087

    Optionally, enables access to the Smart API Explorer from the browser without having to log into SAM.

    <licensing>

    projectName=

    The name of the project that contains the Web API license. This is displayed in the Intergraph Smart Licensing Client, Client settings tab.

    <licenses>
    <license>

    There are three types of WebAPI licenses listed. Uncheck the version(s) purchsed for use with the Web API.

    • The <services> <id=> and <secret=> are temporary values. Update them after registering the Web API, see Register a Web API in Smart API Manager (below).

    • This version of Smart Instrumentation Web API requires Intergraph Smart Licensing Client (ISL).

  4. Save the changes to the configuration file.

  5. Reset the IIS server for the changes to take affect.

Test your Server Connection

  1. On the machine where you installed the Web API server, open a browser window, for example Google Chrome.

  2. In the address line, type the following: https://Your Base URL/api/si/<version number>/Description. The result is a payload containing the API description.

SHARED Tip If no payload is returned with the API description, check that all the settings are correct and try again.

Register a Web API in Smart API Manager

Register your Web API with the API Manager and then update the Web.config file by copying the Resource Identifier and the Secret from your SAM Smart API settings to the Attributes in the Web.config file where you inserted the temporary identifier and secret.