App Directory SDK

Quickstart

Quickstart with Sample Code on Heroku

To get started quickly, you can check out some sample code that we have provided for you using the steps below. Click them to learn more.

Create your App

Before you can create an app, you will need to register to become a HootSuite Developer. To start this process, go to the App Directory SDK overview page and after reading through it, click Apply for Access Now. You will be notified by email when your account is ready.

Once your account is ready and you have become registered as a developer, you can create your own app by filling out this form. As shown in the image below, under Web Hosting select Host my app on Heroku for free (with PHP sample code). New App Form

After submitting the form, wait until you receive an email from Heroku with information about your new app. You will use this information to edit the app later. Heroku Email

Congratulations! You now have a hosted and fully functional app with sample code. View your app information by going to My Apps and clicking on your app's name. Note that the sample app uses SSO (Single Sign On), which works using the sharedSecret. App Information

Under Streams, click View to view and edit your app stream information. App Information

After confirming these details, continue to the next step to Install your App on the Dashboard.

Install your App on the Dashboard

Now that you have created your app on HootSuite, you can install it on your HootSuite dashboard! In your dashboard, go to the App Directory and then click on My Apps. App Information

Click Install App to install your app. App Information

Click the checkbox to select which stream to add, and click Finish to add it to your dashboard. The sample app should appear in your dashboard. App Information

Try out the functions available, and then go on to Making Changes to your App.

Making Changes to your App

Now that you have both created an app and installed it in your dashboard, it is time to learn how to edit the sample app to your own design.

Recall the email you received from Heroku when you first created the app. If you have not yet registered for a Heroku account, follow the signup link in the email.

After you have a Heroku account associated with the email you registered on HootSuite, follow the next steps of Heroku's quickstart guide, Install the Heroku Toolbelt and Login.

You can now use git to clone the sample app code to your machine.

If you get a permissions error, follow these steps:

0. Having the Heroku Command Line Interface installed, log in if you have not already.

heroku login

1. If the file ~/.ssh/id_rsa.pub does not exist, create one by running:

ssh-keygen -t rsa

2. Run this command to add your public key to your Heroku account:

heroku keys:add ~/.ssh/id_rsa.pub

Once you have made your desired changes, use git to push the code to the Heroku repository. Replace EDITED-FILES with the files you edited, or just use -A to add all changes.

If you would like to set up your own locally hosted development environment to see your changes without having to push to the Heroku repository, you can change your app stream to point to https://localhost (or https://localhost:3000 for Ruby on Rails apps). To do this, edit your app stream's <iframe>d HTTPS URL. App Information

Be sure to read Heroku's documentation for explanations of how to do more advanced things with your hosted app, such as scaling your app's workers, database management, etc.