Runscope API Provider Guide

Runscope for API Providers

Help your developer community get up and running with your API faster with these API debugging guides and tools.

Troubleshooting an API problem stinks. Runscope makes it easy.

As an API provider, one of the biggest challenges you face is troubleshooting problems across the wide variety of languages, frameworks and environments used to access your APIs. This guide is designed to help you help your customers solve issues quickly.

Using Runscope, your customers can diagnose API problems in their apps without altering their code. This gives you a look into the actual HTTP requests and responses being generated, removing the need for a prolonged "blind" troubleshooting or recreating your customers' environments (and asking to see their proprietary code). After your customer captures a request, the HTTP message data can be privately shared with your support team.

What kind of problems can Runscope troubleshoot?

If the problem can be solved by inspecting the underlying HTTP request or response generated by your customer's code (in any language or framework), Runscope can help! Here are some examples:

  • Invalid credentials
  • Incorrect URL structure or URL typos
  • Incorrect HTTP method
  • Verifying use of HTTPS
  • Missing required headers or parameters
  • Validating request data (e.g. JSON document structure)
  • Incorrect placement of request data (e.g. request body vs. URL parameters)
  • Mismatched Content-Type header values and actual content type
  • Unexpected redirects (e.g. HTTP redirecting to HTTPS)
  • Malformed webhook receiver responses

How Tos

How To: Troubleshooting HTTP or REST API Requests

How To: Troubleshooting Webhooks

Customizing Examples

You can customize the hostnames used in the examples to reflect your API by appending ? to the URL for a guide (try it).

These instructions are written with your customer in mind. You can place the troubleshooting steps into your API documentation or just copy and paste them into your support emails. Be sure to update the base URL used in the examples to reflect your API.

If you are interested in further customization specific to your API (e.g. instructions for integrating with your official SDKs), please get in touch and we will work with you to put something together.