Implementation Consideration

Before you build an integration application or other client application, consider the data management, use limits, and communication issues explained in this section.

Web API Description

The system implements HTTP services by employing ASP.NET API Web API that can be consumed by a broad range of clients including browsers and handheld devices(smartphones and tablets). It supports variety of GET, PUT and POST request-response message system and provides the result in JSON/XML format.

Recommended Testing Tools

One of the simplest tools for testing is Postman. It is currently one of the most popular tools used in API testing. We will be referencing this tool mostly, but any API testing tool can be used with similar configuration and results.

Before going live, thoroughly test and debug your applications in the Sandbox Mode. You can use your favorite REST client to explore our API, but we recommend the Postman, or Fiddler.

Content Negotiation

With Web API content negotiation, the system returns data based on the client requests. If the client is requesting the data to be returned as JSON or XML, the Web API framework deals with the request type and returns the data appropriately based on the media type. By default Web API provides JSON based response.