Access Smart API Explorer from SAM - Intergraph Smart Instrumentation - Version 2.3.1 - Training - Intergraph

Intergraph Smart Instrumentation Smart API Tutorial

Language
English (United States)
Product
Intergraph Smart Instrumentation
Search by Category
Training
Smart Instrumentation Web Version
2.3.1

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

Method 1

  1. Login into SAM.

  2. On the left pane, click Smart APIs .

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

  4. On the top section of the details page, click 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 click Authorize.

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, click Authorize.

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

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

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

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

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

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

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

  8. Click Try it Out.

  9. Click Execute and explore the response.

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

  • To learn more about the Smart API Explorer, in Smart API Manager Help, click 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.