...
...
...
...
...
| Table of Contents | ||||
|---|---|---|---|---|
|
More information on the API can be found on the API page.
...
Whenever adding or editing an API permission, the API key will be randomly generated and disabled from User modifications. Users can select the Read and Write access in various sections like 'Services', 'Equipment', 'Service Desk', and 'SNMP'. This Grid allows the User to 
, 
, or 
API Key Permissions.
...
Select the desired 'API Permission' and set any desired Expiration Date. Depending on API Endpoint, you will see fields for granting Read and Write permissions.
Edit
Users can an existing API Permission if there are problems with the initial configuration.
Delete
Users can an existing API Permission. Care should be exercised in this action to make sure that the Permission is not being used elsewhere by PCR-360.
...
From 'API Users' Grid the User is able to ,
, or
API Keys associated to a User's Session.
...
From 'API Tokens' Grid the User is able to API Keys Tokens associated to a User's Session. This is very useful if somehow an API Token becomes compromised and another User begins using the Token as well; an Admin User can immediately remove the Token and force all Users of that API Key to re-authenticate, rather than having to wait for the Token to expire.
...
In this basic request example, a user of the API would replace the following:
Parameter | Replace With |
|---|---|
CALLTYPE | We support GET and POST call types, depending on the type of request. |
DOMAIN | The URL used to access your PCR-360 application |
API_KEY | The unique key generated by your admin |
REQUEST_TYPE | The type of request being made. Recommended type is "sql". Other available (deprecated) types are: "servicedesk", "services", and "equipment" |
OUTPUT | The desired output format. |
More specific requests can be done by attaching more fields at the end of the URL in a query string:
| Code Block |
|---|
GET http://DOMAIN/api/API_KEY/REQUEST_TYPE.OUTPUT?field1=value1 ... |
By sending the API_KEY in the Request, the API is able to validate if the user is able to perform the intended operation using the API.
Token Authentication
The Authentication Token is a JSON Web Token.
API Authentication Headers
...
When sending a Request using an Authentication Token, the following headers are R equiredRequired:
| Code Block |
|---|
PCR-AUTH-USERNAME: Caller's User Name PCR-AUTH-PASSWORD: Caller's Password |
...
The system configuration AUTH_SESSION_LIFETIME_SECONDS defines SECONDS defines the length of time a Session is valid. If this parameter is set to "0", then the Session is set to not expire as long as the User. Any other value to cause the User to need to get a new Token after the defined interval, regardless of User Activity.
The system configuration AUTHconfiguration AUTH_SESSION_ACTIVITY_SECONDS defined SECONDS defined the length of time a User's Session is valid, before it times out do to Inactivity.
For more detail on these configuration values, please see the Authentication Configuration Wiki Page.
...
| Code Block |
|---|
CALLTYPE http://DOMAIN/api/KEY/logout.json |
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|