Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
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
- Log into the SummitAI application.
- Select Admin> Basic > Users > User List. The USER LIST page is displayed.
- Click ADD NEW on the ACTIONS The NEW USER page is displayed.
- Select the Domain and specify the User Name.
- On the General tab, specify all the required details.
- On the Access tab, select the Login Type as API Key.
- The API Key of the selected Domain is picked up by the Application by default.
- Specify the API Key Expiry
- Select the Role Template from the list.
- 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 | ||
|---|---|---|
| ||
|
API Authorization
Administrators can provide the authorization to the Analyst based on the Role Template access. For more information, see Role Template Menu Configuration.
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|