|
This topic has moved. To see the updated version, click here then choose your Smart API Manager version. For Smart API Manager versions 2020 (4.0) and earlier, choose help version 4.0. |
|
When you click the link above, a current version of the this topic opens in the Preview window. The Version drop-down at the top of the window shows which version you're looking at. To see a different version, select it from the drop-down:
If you click the Read the topic in context button at the bottom of the Preview window, you will open the topic in the help for the selected version.
|
Anytime you are looking at the help, you can switch to the help for a different version
using the drop-down at the top of the help window.
Smart APIs are RESTful web APIs developed by Hexagon PPM. These APIs typically provide access to data associated with software applications like SmartPlant Foundation or Smart 3D.
How level of access to a Smart API is determined
Smart API Manager uses groups to manage and control user access to a Smart API.
-
If a specific user needs to call a Smart API, that user—or an external identity representing the user—must belong to a group that is authorized to access the Smart API.
-
The claim values for a group can provide more granular control, depending on the particular Smart API and the claims it provides. For example, a Smart API might provide a claim to control whether users in a group are allowed to write data using the API or have read-only access.
Claims are provided by the Smart APIs, and you should consult the specific Smart
API Help for assistance in setting appropriate claim values.
Smart API setup
There are two tasks to initially set up Smart APIs:
-
Typically, Smart APIs are registered immediately after their installation using a
configuration tool provided with the Smart API installation. However, if necessary,
you can register the Smart API in Smart API Manager.
Smart API administration
After a Smart API is registered, administration tasks help you meet the ongoing access and security needs of your company.
|
To Change |
See These Administration Tasks |
|---|---|
|
Which groups have access to a Smart API |
|
|
The level of access a group has to a Smart API |
|
|
Whether a Smart API is accessible to any group |
|
|
Claims defined for a Smart API |
|
|
Valid values for a Smart API enumerated claim |
|
|
The secret that a Smart API must provide in its web.config |
|
|
Location of the Smart API |
|
|
The Smart API name or other information |
If you do not know which Smart API you need to modify, start with Find a Smart API.