Skip to content
This repository has been archived by the owner on Dec 28, 2020. It is now read-only.

Customize API Registration

Chris Carlevato edited this page Mar 27, 2017 · 1 revision

Access to some third party APIs supported by Helios Calendar requires additional registration and configuration.

Facebook

Within the Facebook section of your admin console APIs & Services click the “Sign Up” link or visit https://developers.facebook.com/apps

  • Sign in, if you are not signed in already, to your Facebook account
  • Click “Create New App”.
  • Enter your App Name (the name of your calendar/site) and click Continue.
  • In your App's “Basic Info” update your Contact Email - this will be publicly available and should be the email address you use for customer service/support.
  • In your App's “App Domain” enter your site URL (This should just be your.com, not the full URL of your Helios install).
  • Under the heading “Select how your app integrates with Facebook” select “Website with Facebook Login” and enter the full URL of your Helios Calendar install. Ex: http://demo.helioscalendar.com No other option should be selected/checked/active.
  • Click “Save Changes”

Within the advanced section of your Facebook app settings ensure you have the following configured:

  • App Type: Web

Other settings can be configured to the preferences/needs of your site.

After completing creation of a new “app” in Facebook you will need to save the credentials provided by Facebook to your Helios Calendar settings. These settings are located within the Facebook section of your Helios Calendar admin console APIs & Services.

  • Copy the App ID/API Key from Facebook to your Application ID setting.
  • Copy the App Secret from Facebook to your Application Secret setting.

After adding both settings click “Save Settings” to save your Helios Calendar settings. You can now configure optional settings like public calendar sign in with Facebook and publishing status updates & events to your Facebook page within your APIs & Services settings.

Troubleshooting

  • PHP 5.2 is not supported. If you receive a “blank” list of publishing options when connecting your Facebook account please confirm your PHP version.
  • Access Tokens are time limited. If you receive a blank page when publishing status updates or events you should first re-Connect your app to your Facebook account to regenerate your access token.
  • OpenSSL support must be enabled on your server for the Facebook API integration to work. You can confirm your OpenSSL support by viewing Help/About Helios Calendar - within your admin console. OpenSSL details for your server are available in the About This Install section.
  • Your Helios Calendar install's Facebook auth pages must be publicly accessible to permit API authorization. In addition the domain configured within your Facebook App must be publicly accessible and the domain where your Helios install is located - parked domains will not work.
  • If you need to “reboot” access to your Helios Calendar Facebook App within your Facebook account simply remove your Helios Calendar Facebook App from your Facebook account. Account Settings/Apps, click the X next to your Helios app. This will allow you to re-Connect your account to your app.
  • localhost installs can, occasionally, receive inconsistent data from the API. Testing should occur on the live/production domain.

Twitter

Within the Twitter section of your admin console APIs & Services click the “Sign Up” link or visit https://dev.twitter.com/apps

  • Sign in, if you are not signed in already, to your Twitter account.
  • Click “Create New Application”.
  • Enter your app Name - the name of your site/calendar.
  • Enter your app Description - this will be displayed to users if you allow public calendar sign in with Twitter.
  • Enter your app Website - the URL of your Helios Calendar install.
  • Enter your Callback URL. (Callback URL isn't labeled as Required in the form but it is required for Helios to work with the Twitter API. Your Callback URL should be the full URL of your Helios Calendar install.
  • Click “Create your Twitter application”.

After completing creation of your app you will need to configure it's settings.

  • Select the “Settings” tab.
  • Under the heading Application Type change Access to “Read and Write”. Without Read & Write access Helios API publishing to Twitter will not work.
  • Confirm your Callback URL is set correctly. Without a valid Callback URL Helios API publishing to Twitter will not work.
  • Click “Update this Twitter Applications settings”.

After completing configuration of your app settings you will need to save the credentials provided by Twitter to your Helios Calendar settings. These settings are located within the Twitter section of your Helios Calendar admin console APIs & Services.

  • Select the “oAuth tool” tab.
  • Copy the Consumer Key from Twitter to your “Consumer Key” setting.
  • Copy the Consumer Secret from Twitter to your “Consumer Secret” setting.

After adding both settings click “Save Settings” to save your Helios Calendar settings. You can now configure optional settings like public calendar sign in with Twitter and your admin tweet hashtag within your APIs & Services settings.

Google

Within the Google section of your admin console APIs & Services click the “Sign Up” link or visit https://code.google.com/apis/console

  • Sign in to your Google account.
  • Under APIs & auth click Credentials
  • Under OAuth, click "Create new Client ID' button
  • Enter your website URL for Authorized JavaScript origins
  • Enter your Helios Calendar URL plus /signin/google.php as Authorized redirect URIs

After completing configuration you will need to save the credentials provided by Google to your Helios Calendar settings. These settings are located within the Google section of your Helios Calendar admin console APIs & Services.

  • Copy the Client ID from Google to your “Client ID” setting.
  • Copy the Client Secret from Google to your “Client Secret” setting.

After adding both settings click “Save Settings” to save your Helios Calendar settings. You can now configure the optional setting of public calendar sign in with Google.

Clone this wiki locally