Capture your HTTP traffic

The SDK acts as a very thin layer around the JSON serialization and HTTP web requests. Most of that thin layer is covered by unit tests.

The #1 source of errors when using the SDK is a web request failure, not a bug in the actual SDK itself.

Your code issues a request using the Standard Request/Response DTO Pattern and the received response indicates a failure for some reason and the SDK throws a WebServiceException. Maybe the request parameters were incorrect, or maybe the server hit an internal error.

In either scenario, capturing the failing request/response pair is an essential skill to help you figure out what went wrong.

Learn how to use traffic monitoring tools like Fiddler to capture your application's HTTP traffic. Fiddler is a wonderful free tool that will save you hours of head-scratching. Fiddler can also export its captured traffic to "session" files, which can be useful artifacts to attach when reporting SDK bugs.

Fiddler and .NET are automatic

Using Fiddler with .NET programs is fairly automatic. Just launch Fiddler and leave it running in the background while you run your application.

Fiddler and Java require a bit more manual configuration

This note describes various ways to configure the Java runtime to route its requests through Fiddler's http://127.0.0.1:8888 proxy address.

This note also gives some useful JVM configuration examples.