The 10-Minute API: Getting an API Up and Running in 10 Minutes with 3scale, Grape and Heroku

APIs (Application Programming Interfaces) can be complex and challenging to operate – but it doesn’t have to be hard to get started. To prove it and also inaugurate our video tutorial series we figured we’d show how to get a very simple API up, running and hosted easily in less time than it takes to cook a hot dinner.

Up and Running API: Grape, 3Scale, Heroku

To get our API up and running we used:

  • Grape: a lightweight web framework on top of Ruby similar to Sinatra but focused on REST Web APIs. The frameworks makes it very easy to declare resources, set up method calls and manage responses. Also see Michael Bleigh’s cool rubconf presentation on slideshare.
  • 3scale: providing out of the box authentication for the API and allowing us to issue developer keys right from launch.
  • Heroku: a free Heroku account to host the API when it’s done.

The example is a simple Sentiment Analysis API – the code for which you can find on github shortly. We’ll build on this example and add lots of fun stuff in future episodes.

For now, sit back and check out the video:

[UPDATE: the source code for all the examples is now available in our example Github repo].

Look out for the next episode on adding analytics coming up soon! We hope you enjoy using Grape and 3Scale for your API needs.