API Specification Guide

Revision Histoty

Version No	Prepared By	Reviewed By	Created/Reviewed Date	Changes Made

1.Executive Summary

1.1 Introduction

In this section, Please provide introduction to the API and what business functionality being implemented.

1.2 Scope

Please provide the business services which are in scope as part of this API and describe the methods.

1.3 Intended Audience

1.4 Abbreviation, Acronyms and Definitions

2.Business Service Design

2.1 Introduction

Web services are self-contained modular business applications that have open, Internet oriented, standards-based interfaces. Web services are loosely coupled, communicating directly with other Web services via the Internet using standards-based technologies. This standards-based communication allows Web services to be accessed by customers, suppliers, and trading partners independent of hardware, operating system, or even programming environment. The result will improve time to integration and lower the overall cost of ownership of integration solutions compared to today’s SOA, EDI and B2B solutions. The result will be an environment where businesses can expose their current and future business applications as Web services that can be easily discovered and consumed by external partners.

3.Service Specification

3.1 HTTP Header Application Area Metadata Details

Please provide any additional HTTP headers being used for this API.

3.2 Web Service Security

Provide the OAUTH security detail informations.

3.3 API Information

3.3.1 Endpoint URL

Provide the endpoint informations about the service.

3.3.2 Request Elements

Provide the request element informations about the service.

3.3.3 Response Elements

Provide the response element informations about the service.

4.Error Handling