Using this feature, you can register your client/daemon application with Smart Cloud portal. Usually, during the registration process, an existing Smart Cloud portal user is assigned as an owner to the client/daemon application.
Enabling client registration for an estate requires configuration changes. Contact
Cloud Service Desk for enabling client application registration.
To register the client application:
-
Click Estate Automation.
-
Click Client Applications.
-
Select the required Estate from the Estate Groups.
-
Click Register.
-
Enter user friendly name in the Client Application Name textbox.
-
Select the application name of which you want to use the APIs from the Application API Name drop-down list.
-
Select an owner for this custom application from the Owner Name drop-down list. The owner associated with the client credentials will be used as a Thumb print to access the Smart API within the application.
As a standard practice, to ensure that the data usage via APIs is not misused, Hexagon
strongly recommends that you provide valid employee name as an application owner instead
of a DL or a fictitious login ID.
-
Select a site name from the Site Name drop-down list.
Smart Build users need not mention any site name.
-
(Optional) Enter the description and comments if required.
-
Click Submit. With this, the following takes place:
-
The client is registered.
-
The Client ID and Client Secret are generated.
-
-
Select the required client application to view its details in the action pane.
-
Use the generated Client ID and Client Secret in the client/ daemon application to access the Smart APIs.
What should you do after registering the Client Application?
After you register the Client Application, you must make a note of the following details and provide them in your client application to consume the Smart API.
-
Smart API URL (can be retrieved from Description URL response)
-
Client Id (ISC Portal)
-
Client Secret (ISC Portal)
-
Scope (can be retrieved from Description URL response)
This application will be active only if the owner’s state is Active.
The client/daemon application cannot access required APIs if the user who is assigned as an owner gets deactivated/ deleted due the following reasons:
-
The product is unassigned for this user.
-
The user is moved to locked state.
-
The user is deleted from the Smart Cloud database.
If the owner gets deactivated due to any of the above reasons, the owner’s state changes to one of the following:
-
Product Unassigned: Indicates that the product has been unassigned for this owner.
-
Locked Out: Indicates that the owner is in locked state.
-
Deleted: Indicates that the owner is deleted from the Smart Cloud database.
In this case, the client/daemon application must be registered again with another
user.
Once the registration process is complete, a Client ID and Client Secret are generated which you can use in your client/daemon application to access required information through the Smart APIs.
If the customer purchases SDx products (that is, the SDx Proj and SDx Operations),
then the customer is automatically entitled to use the SDx APIs. Also, the customer
will be able to register the client application which will then consume the APIs.
Guided Simulation for Client Application Registration