API Authentication and Authorization

Owned by Enterprise IT
May 10, 2024
1 min read

API URL

The SummitAI API URL is http://<Base_URL>/REST/Summit_RESTWCF.svc/RESTService/ CommonWS_JsonObjCall. Replace <Base_URL> with the customer’s API Server URL.

API Authentication

You can authenticate all SummitAI APIs  using an API Key. From the Sierra HF01 release onwards, SummitAI implemented the default Token-based API authentication for Web Services. The authentication requires the following key value pairs in the Request body:

  • AuthType": "APIKEY",

  • APIKey: "XXXXXXXXXXXXX"

Generate an API Key

  1. Log into the SummitAI application.
  2. Select Admin> Basic > Users > User List. The USER LIST page is displayed.
  3. Click ADD NEW on the ACTIONS The NEW USER page is displayed.
  4. Select the Domain and specify the User Name.
  5. On the General tab, specify all the required details.
  6. On the Access tab, select the Login Type as API Key.
  7. The API Key of the selected Domain is picked up by the Application by default.
  8. Specify the API Key Expiry
  9. Select the Role Template from the list.
  10. Click SUBMIT.

Note:

After generating an API Key, copy it and save it securely. If the API Key expires, go to the User Details page and update the API Key Expiry date.

Note:

  • To enable the User Name and Password-based authentication, add the below key in the web.config file:
    <add key="IsAPIKeyDisabled" value="true" />
  • If you don't add the key in the web.config file or if the specified value of this key is false, by default, the Token-based API authentication gets enabled for the Web Services.

API Authorization

Administrators can provide the authorization to the Analyst based on the Role Template access. For more information, see Role Template Menu Configuration.