Getting Started with API Debugging

The first step to solving API integration issues is seeing the request and response data traveling back and forth from the client to the API. With the Global Traffic Gateway and the API Traffic Inspector, viewing API request and response data for any API call is easy.

Let's get started by making a request through Runscope that we can view and interact with in the Traffic Inspector. First, sign up for your free Runscope account.

Step 1: Learn the Lingo

Requests
A request is any HTTP API call that you make through Runscope. Every request is stored in a bucket.

Buckets
Buckets are a simple way to organize your traffic. You can create buckets by project, customer, app or anything else you like. Every bucket has a unique key you'll use when creating Gateway URLs.

Step 2: Make a Request

In order for Runscope to capture traffic you need to direct it through our gateway. This is accomplished with special Gateway URLs that contain the target API host name along with your bucket key.

The basic formula for creating a Gateway URL is:

  • Start with the scheme and hostname of the target API. For this example we'll use https://api.yourapihere.com.
  • Replace the dots with dashes. If the hostname has dashes, double them up.
  • Append a dash, your bucket key and runscope.net. We now have https://api-yourapihere-com-bucket_key.runscope.net.

From your code or other HTTP client, execute the API call with the Gateway URL you created. The path, headers, request data and URL querystring parameters do not need to change.

That's It!

Once your traffic is flowing through Runscope you can:

Have questions about getting started? We're standing by ready to help.