Minimum Version Required: 22.01
Fields And Definitions
Auto deactivate and delete policies
In order to maintain a clean system and ensure reliability and performance, API Commands are automatically deactivated and deleted after certain periods of inactivity.
Any API Command that is not used for 210 days will be auto-deactivated, as long as Delete Protection is turned OFF.
Usage is measured from production systems only.
If Delete Protection is turned ON, the API Command will be auto-deactivated after 760 days of no usage.
There is not a way to extend the time limit beyond 760 days.
Any API Command that has been in the Active=False state for more than 365 days will be automatically deleted.
The deleted record for the API Command and the API Parameters under it will be available in the deleted records table for an additional 6 months, if they are needed for reference.
Security policies
If an API is accessed using the API Token (instead of the session of a logged in user), then the API Token should be send in the body of the HTTP request.
APITokens must not be shared outside of the users working on the APIs, Tokens should be treated with the same level of security as someone's password.
The 'Timeout In Seconds' and 'Processing Limit (Minutes per Hour)' should be set within a reasonable limit based on the intended usage of the API. Encompass reserves the right to change these settings if an API is causing larger system performance impacts.