API Settings

Local API

• API Version - Version number for the API in use on the local Helios Calendar.
• API Endpoint - Endpoint URL for the local API.

Local API Cache

When the cache type setting is configured for APC this section will contain an overview of the recent users to access the API that are stored in memory. API access counts can be written to the database, and the memory entries cleared, by clearing the calendar cache from the admin console homepage.

• Next Write - Timestamp for when the memory will be automatically purged and call counts written to the database.
• Username - List of most recently active users stored in memory (to reduce database connection overhead).
• API Calls - The number of API calls made by the user since they were added to memory.
• User Edit - Click this icon to edit the user and review their account information.

Local API Settings

• API Status - Turns the API on/off. When off all API calls will result in a 301 redirect to the calendar homepage.
• Cache Type - Type of cache to use for the API.
• None - No cache will be used, all API response data will be generated by database connectivity.
• File - Filesystem caching will be used, all API response data will be cached to the /cache directory.
• Alternative PHP Cache (APC) - Memory caching via APC. All API response data will be cached to memory.
• Event List Max Size - Maximum number of events to return for API calls.
• Newsletter List Max Size - Maximum number of newsletters to return for API calls.

APC Settings

When Cache Type is set to APC the following additional settings will be available.

• APC User Limit - Number of users to store in memory. When the user list exceeds this limit only this number of the most recently active users will be retained. The user with the longest inactivity will have their count written to the database and be removed from memory.
• APC Write Time - Time, in minutes, between full writes to the database. When this period ends all users presently stored in memory will have their call counts written to the database and the user list will be purged from memory (to be rebuilt as subsequent API calls occur).

Note: APC cache type option will only be available in environments where the APC extension is installed.

Saving Setting Changes

Once setting changes have been made click the “Save Settings” button to save the settings and apply any changes immediately.