Table of Contents | ||||
---|---|---|---|---|
|
...
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 edit 'Edit' an existing API Permission if there are problems with the initial configuration.
Delete
Users can delete 'Delete' 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.
...
User Access Validation for the API
Anonymous Mode
This mode of accessing the API has been depreciatedHTTP POST is required for the login endpoint.
A basic request looks like this:
...
When sending a Request using an Authentication Token, the following headers are requiredare Required:
Code Block |
---|
PCR-AUTH-USERNAME: Caller's User Name PCR-AUTH-PASSWORD: Caller's Password |
API Authentication
HTTP POST is required for the login endpoint.
A basic request looks like this:
Code Block |
---|
CALLTYPE http://DOMAIN/api/KEY/authlogin.phpjson |
This call returns an Authenticated Token that can be used in other API calls. Depending on how User access is configured, the returned Token grants access during a configurable window.
Once Authenticated the following header is required Required for all other Requests:
Code Block |
---|
PCR-AUTH-TOKEN: Caller's Authentication Token |
...
The system configuration AUTH_SESSION_LIFETIME_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 AUTH_SESSION_ACTIVITY_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.
API Logout
To end your Session with the API, call the Logout Endpoint. This will end your current Session, and require you to authenticate again before you make another call using the API.
Code Block |
---|
CALLTYPE http://DOMAIN/api/KEY/logout.phpjson |
Child pages (Children Display) | ||||
---|---|---|---|---|
|