Customize APIs

Helios Calendar includes integration with several 3rd party web services and APIs. To use these services with your Helios Calendar you'll need to register with the service provider(s) and save your account and/or API access information within your Helios settings.

Maps

• Maps Library - The maps library to use on the public calendar.
• Google Maps - Enables Google Maps service for maps within the public calendar.
• OpenLayers - Enables OpenLayers library.
• Event & Profile Map Zoom - Default zoom for maps embedded within Event Details & Location Profiles.
• Location Browse - Turn the location browse map in public calendar On/Off.
• Map Syndication - Location map syndication setting.
• On - A syndication map cache is generated and syndication instructions are available in the public calendar tools section.
• Off - The syndication map cache is deleted (and recreation prevented) disabling third party sites syndicating the location map. Map syndication instructions are not displayed in the public calendar.
• Locations Map Zoom - Default zoom level for location browse map.
• Locations Map Center - Default center display point (focus) of the location browse map.

The Maps Library setting will determine which of the following options are available.

Google Maps

• Google Maps URL - The Google Maps URL to use for embedded Google Maps. Can be modified to localize Google Maps controls.

OpenLayers

• Map Tile Provider - The map tiles to use with OpenLayers. Note: Some tile providers require registration and unique API key for use. To maintain compliance with third party tile providers terms of use only one provider at a time can be used.

Use of the Bing Maps API requires an API Key and is subject to their Terms of Service. Use of the Google Maps API is subject to their Terms of Service. Use of MapQuest Tiles is subject to their Terms of Service. Use of the Yahoo Maps API requires an API Key and is subject to their Terms of Service.

Comments

• Show Comments Quick Link - Check this box to include comment service provider link in the admin console quick links.
• Calendar Comments
• Comments Off - Turn comments off for the entire calendar.
• Use Disqus - Use Disqus for event & location comments.
• Use Facebook Comments - Use Facebook Comments service for event & location comments.
• Use Livefyre - Use Livefyre for event & location comments.

The Calendar Comments setting will determine which of the following options are available.

Disqus

• Disqus Shortname - Your site shortname, created when you register your site.

Facebook Comments

• Facebook Posts - Number of posts to display by default.
• Facebook Width - Width of the comment plug-in, in pixels.

Livefyre

• Livefyre Site ID - Your unique Livefyre ID, created when you register your site.

Use of Disqus requires a Disqus account and is subject to their Terms of Service. Use of Facebook comments is subject to their Terms of Service. Use of Livefyre requires a Livefyre account and is subject to their Terms of Service.

Facebook

For assistance registering your Helios Calendar install as a Facebook app please see API Registration.

• Show Facebook Quick Link - Check this box to include Facebook in the admin console quick links.
• Application ID - Your Facebook Application ID, provided when registering your app.
• Application Secret - Your Facebook Application Secret, provided when registering your app.

Once your Application ID & Secret are saved within your Helios settings the following options will be available.

• Sign in with Facebook - Turn public calendar sign in with Facebook On/Off.
• Connect - Click to connect your Helios Calendar Facebook App with your Facebook account for publishing status updates & events to your Facebook page.

Once connected with your Facebook account the following settings will be available.

• API Token Expires - Date your Facebook Token Expires. Re-Connect before this date to extend token lifespan for continued API publishing access. Re-Connect after expiration to restore API publishing access.
• Publish To - A select list containing locations your Facebook account has access to publish to. This list will include your Facebook account and any pages for which you are an admin. Selected option is where Helios will publish events & status updates.
• Revoke Authorization - Check this box and save API settings to remove Facebook API access from your Helios Calendar. Note: This will revoke authorization within the local Helios Calendar install only. Sign in to your Facebook account to manage app access to your account.

Note: While Helios Calendar makes use of the extended life token a “permanent” token is not available. As a result the Facebook account owner must “re-connect” Helios Calendar with the account for ongoing access. At present this requirements is once every sixty days. To ensure account security this reconnection is NOT automatic and must be performed by the user.

Use of the Facebook API requires a Facebook account and is subject to their Terms of Service.

Twitter

For assistance registering your Helios Calendar install as a Twitter app please see API Registration.

• Show Twitter Quick Link - Check this box to include Twitter in the admin console quick links.
• Consumer Key - Your Twitter Consumer Key, provided when registering your app.
• Consumer Secret - Your Twitter Consumer Secret, provided when registering your app.
• Hashtag - Your custom hashtag, included with tweets.

Once your Consumer Key & Secret are saved within your Helios settings the following options will be available.

• Sign in with Twitter - Turn public calendar sign in with Twitter On/Off.
• Tweet As - Click the Sign in with Twitter button to connect your Helios Calendar Twitter App with your Twitter account for publishing admin event tweets.

Once connected to your Twitter account the following settings will be available.

• Tweet As - Name of the Twitter account your Helios Calendar will tweet as/to.
• Revoke Authorization - Check this box and save API settings to remove Twitter API access from your Helios Calendar. Note: This will revoke authorization within the local Helios Calendar install only. Sign in to your Twitter account to manage app access to your account.

Note: Use of the Twitter API for admin tweets also requires bitly API activation.

Use of Twitter API is subject to Twitter's Terms of Service.

Google

For assistance registering your Helios Calendar install as a Google OAuth client please see API Registration.

• Client ID - Your Google Client ID, provided when registering your client.
• Client Secret - Your Google Client Secret, provided when registering your client.

Once your Client ID & Secret are saved within your Helios settings the following options will be available.

• Sign in with Google - Turn public calendar sign in with Google On/Off.

Use of Google APIs requires a Google account and is subject to their Terms of Service.

Eventbrite

• Show Eventbrite Quick Link - Check this box to include Eventbrite in the admin console quick links.
• Eventbrite API Key - API key for use of the Eventbrite API
• Eventbrite User Key - User key for use of the Eventbrite API

Once your API & User Key are saved within your Helios settings the following options will be available.

• Default Organizer - A list of available Organizers will be retrieved from the Eventbrite API. Select which Organizer you want to use as the default selection for publishing events to Eventbrite.
• PayPal Email - PayPal account email address to use for Eventbrite ticket sales.
• Google Merchant ID - Google Merchant ID to use for Eventbrite ticket sales.
• Google Merchant Key - Google Merchant Key to use for Eventbrite ticket sales.

Note: PayPal/Google Merchant settings are optional. However, if they are not saved you will need to manually “activate” ticket sales for events within your Eventbrite account after publishing them. When saved Helios will simply provide this information to Eventbrite through their API, all ticket sales will occur through the Eventbrite service & the merchant of your choice (PayPal/Google).

Use of Eventbrite API is subject to Eventbrite's Terms of Service.

bitly

• Show bitly Quick Link - Check this box to include bitly in the admin console quick links.
• bitly Username - Your bitly username.
• bitly API Key - API key required to access the bitly API.

Use of bitly API is subject to bitly's Terms of Service.