Debug Force.com REST Calls with Runscope

I love APIs. I love to build them, cURL them, read their source code and talk about them. One of the aspects that I haven't loved so much is debugging them. That is until I found Runscope. We've been using the service for a couple of months and it's made debugging, testing and/or inspecting APIs sooo much easier. Of course Runscope works for all languages and essentially any REST API but we've found it especially helpful to build, test and debug Force.com REST calls.

Runscope was co-founded by John Sheehan who also loves APIs. I've know John since his Twilio days and he's done an awesome with Runscope. The interface is very clean and service is intuitive and easy to use. If you are interested in APIs, you should subscribe to his API Digest newsletter.

Check out the video below on how to use Runscope with your Force.com REST APIs but in a nutshell here's how it works. It's a pretty simple process:

  1. Sign up for a free Runscope account
  2. Use the Runscope URL for the REST calls in your application to Force.com. For instance, your calls to http://cs8.salesforce.com will look something like http://cs8-salesforce-com-g0aderfwxe.runscope.net
  3. Once requests are captured, view your calls to Force.com in detail with the Traffic Inspector. Complete request and response data (URL, querystring parameters, form data, status, etc.) is available. There's also a sweet little inspector where you can compare the deltas of two different calls!
  4. You can also create a shareable link to give to someone else to send, view, and comment on any of your API calls.

If you sign up for the paid version, you can use their Passageway service which allows you and your team to temporarily share your local development web server with others via a public URL. You can then of course run requests for localhost through Runscope and inspect traffic. Brillant!