API and business language schema design framework for message exchanges

• US 20050138648A1
• Filed: 11/24/2004
• Published: 06/23/2005
• Est. Priority Date: 11/24/2003
• Status: Active Grant

• Current Assignee: eBay Inc.
• Original Assignee: eBay Inc.
• Inventors: Avalani, Bhaven, Yue, Gary, Tanaka, Ray, Cohen, Alon, Kao, Daniel, Ahmed, Zahid
• Granted Patent: US 7,818,759 B2
• Time in Patent Office: Days
• US Class Current: 719/328
• CPC Class Codes: G06F 2209/541 Client-server
• CPC Class Codes: G06F 9/451 Execution arrangements for user interfaces
• CPC Class Codes: G06F 9/54 Interprogram communication
• CPC Class Codes: G06F 9/547 Remote procedure calls [RPC]; Web services
• CPC Class Codes: G06F 9/548 Object oriented; Remote method invocation [RMI] non-remote method invocation G06F9/449
• CPC Class Codes: G06Q 30/08 Auctions
• CPC Class Codes: H04L 67/01 Protocols
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]
• CPC Class Codes: H04L 67/10 in which an application is distributed across nodes in the network software deployment G06F8/60; multiprogramming arrangements G06F9/46
• CPC Class Codes: H04L 67/133 Protocols for remote procedure calls [RPC]

Abstract

A server system facilitates an exchange of messages with a remote client application. The server system includes a plurality of application servers hosting a plurality of applications. A plurality of Application Program Interfaces (APIs) provides programmatic access to the plurality of applications, each of the APIs being configured to receive request messages compiled by the remote client application. First and second request messages, respectively addressed to first and second APIs of the plurality of APIs by a remote client application, each comprise at least one common data component. Further, the first request message includes a first payload specific to the first API, and the second request message includes a payload specific to the second API.

Claims

1. A server system to facilitate an exchange of messages in an electronic trading system with a remote client application, the server system including:

a plurality of application servers hosting a plurality of applications; and

a plurality of Application Program Interface (API) servers hosting APIs to provide programmatic access to the plurality of applications, each of the APIs being configured to receive request messages compiled by the remote client application,

wherein first and second request messages, respectively addressed to first and second APIs of the plurality of APIs, each comprise at least one common data component, and wherein the first request message includes a first payload specific to first API and the second request message includes a second payload specific to the second API.

2. The system of claim 1, wherein the at least one data component is selected from a group comprising a predetermined required level of detail, an error language component and a version identifier.

3. The system of claim 1, wherein each of the APIs is configured to generate a response message to be sent from the server system to the remote client application, responsive to a received request message.

4. The system of claim 1, wherein the response message comprises an acknowledgement component for acknowledging receipt of the request message, a correlation identifier, a timestamp, error data and version data.

5. A method of facilitating an exchange of messages between a remote client application and a server system, the server system being capable of supporting a plurality of application program interfaces, the method including:

receiving a plurality of request messages generated by the remote client application, each request message requesting an activity to be performed by a targeted API with respect to an associated application and comprising at least one data component that is common to each of the plurality of request messages, and a request component that is specific to the targeted API

extracting the at least one data component and the request component from the request message; and

performing the activity requested by the request message.

6. The method of claim 5, including performing version and error check operations.

7. The method of claim 5, including generating a response message that is to be sent from the server system to the remote client application.

8. A method according to claim 6, wherein the generating of the response message includes generating an acknowledgement, a timestamp, a correlation identifier, error data and version data.

9. A machine-readable medium comprising instructions which, when executed by a machine, cause the machine to perform a method of facilitating an exchange of messages in a trading system between a remote client application and a central server system, the server system being capable of supporting a plurality of application program interfaces, the method comprising:

receiving a plurality of request messages compiled by the client application, each request message comprising at least one data component that is common to each of the plurality of request messages, and a request component that is specific to one of the plurality of application program interfaces, to support the functionality of the requested application program interface;

extracting the at least one data component and the request component from the request message; and

performing the activity requested by the request message.