Access Smart API Explorer from SAM - Intergraph Smart Instrumentation - 2.3.15 - Training - Intergraph

Intergraph Smart Instrumentation Web API Tutorial

ft:locale
en-US
Product
Intergraph Smart Instrumentation
Subproduct
Web API
Search by Category
Training
Smart Instrumentation Web Version
2.3

There are several ways to access Smart API Explorer from SAM:

Method 1

  1. Login into SAM.

  2. On the left pane, select Smart APIs .

  3. Choose the Smart API in the grid to see its details.

  4. On the top section of the details page, select Smart API Explorer icon to explore the Smart API.

  5. On the Available authorizations page, select the OAuth.Implicit (OAuth2, implicit) flow.

  6. Select the check-box under Scope and select Authorize.

    Available athorizations dialo box (API)

Method 2

This method allows you to use Smart API Explorer without running SAM first.

  1. In a web browser type the Url using this format::

    <SAM server Issuer>/sam/open-api/?url=<baseUri>api/si/{{versionNumber}}/doc

    For example: https://samserver.ingrnet.com/sam/open-api/?url=https://mywebapi.ingrnet.com/api/si/v2/doc

  2. On the Intergraph Smart Instrumentation Smart API window, select Authorize.

    SI Web API Window

  3. On the Available authorizations page, select the OAuth.Implicit (OAuth2, implicit) flow.

  4. Select the check-box under Scope and select Authorize.

    Available athorizations dialo box (API)

  5. On the SAM log-on dialog box, do one of the following:

    • Enter an authorized SAM user name and password (local credentials) and select SIGN IN.

    • If you sign in with Windows Authorization select SIGN IN WITH.

  6. When you receive authorization, on the Available authorizations dialog box select Close.

  7. In the web browser, select GET/$metadata.

    GET/$metadata

  8. select Try it Out.

  9. select Execute and explore the response.

  • The Open API client enables different methods of requests. However, the Web API only supports GET requests at this point.

  • To learn more about the Smart API Explorer, in Smart API Manager Help, select Help > Smart APIs > Explore a Smart API (or in the Search box, type: Explore a Smart API). You can also check on the internet, there are plenty of resources with tutorials and videos.