API and business language schema design framework for message exchanges

• US 8,352,968 B2
• Filed: 01/04/2011
• Issued: 01/08/2013
• Est. Priority Date: 11/24/2003
• Status: Active Grant

• Current Assignee: eBay Inc.
• Original Assignee: eBay Inc.
• Inventors: Ahmed, Zahid N., Cohen, Alon, Kao, Daniel Tsun, Tanaka, Ray, Yue, Gary, Avalani, Bhaven
• Primary Examiner(s): Wu, Qing
• Application Number:
  US12/984,461
• Publication Number:
  US 20110167430A1
• Time in Patent Office: 735 Days
• Field of Search: None
• 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 method of facilitating an exchange of messages between a remote client application and a server hosting a plurality of applications coupled to at least one Application Programming Interface (API), the method comprising:

receiving in a targeted API a request message from the remote client application;

the request message having an abstract message portion that includes an abstract message payload and an API-specific message portion that includes an extended message payload comprising a request to perform an activity and a reusable identified schema definition specific to the targeted API;

performing the activity by calling one or more function calls in the one of the plurality of applications from the targeted API;

wherein the targeted API facilitates communication between the one application and the remote client application.

2. The method of claim 1 wherein the abstract message portion is extensible for a plurality of different types of messages.

3. The method of claim 1 wherein the abstract message portion is extensible over a plurality of different protocols.

4. The method of claim 1 wherein the schema definition is used in a method comprising performing version and error check operations in the targeted API.

5. The method of claim 4 further including generating a response message that is to be sent to the remote client application.

6. The method of claim 5 wherein generating a response message includes generating an acknowledgement, a time stamp, a correlation identifier, error data, and version data.

7. The method of claim 1 wherein the server resides in an electronic trading system and the API is responsive to the API-specific message portion for multiple cases of purchasing and selling items via the electronic trading system.

8. The method of claim 7, wherein the multiple cases include at least one case selected from the group of cases consisting of:

listing an item, revising and relisting an item, and getting information about an item.

9. The method of claim 7 wherein the API is responsive to the API-specific message portion, such portion having an item data component and multiple data validation levels.

10. The method of claim 9 wherein the API-specific message portion further comprises an identified schema definition specific to the targeted API, at least one of the multiple data validation levels being selected from the group of data validation levels consisting of schema level data validation, API specific syntactic data validation, and business application data validation.

11. A non-transitory computer-readable storage medium having embedded therein a set of instructions which, when executed by one or more processors of a computer causes the computer to execute the following operations:

using a computer processor, receiving in a targeted API a request message from the remote client application, the request having an abstract message portion that includes an abstract message payload and an API-specific message portion that includes an extended message payload comprising a request to perform an activity and a reusable identified schema definition specific to the targeted API, the schema definition used in a method comprising performing version and error check operations in the targeted API; and

performing the activity by calling one or more function calls in the server applications from the targeted API, the targeted API facilitating communication between the server application and the remote client application.

12. The storage medium of claim 11 wherein the abstract message portion is extensible for a plurality of different types of messages.

13. The storage medium of claim 11 wherein the abstract message portion is extensible over a plurality of different protocols.

14. The storage medium of claim 11 further including generating a response message that is to be sent to the remote client application.

15. The storage medium of claim 14 wherein generating a response message includes generating an acknowledgement, a time stamp, a correlation identifier, error data, and version data.

16. The storage medium of claim 11 wherein the server resides in an electronic trading system and the API is responsive to the API-specific message portion for multiple cases of purchasing and selling items via the electronic trading system.

17. The storage medium of claim 16, the multiple cases including at least one case selected from the group of cases consisting of listing an item, revising and relisting an item, and getting information about an item.

18. The storage medium of claim 16 wherein the API is responsive to the API-specific message portion, such portion having an item data component and multiple data validation levels.

19. The storage medium of claim 18 wherein the API-specific message portion further comprises an identified schema definition specific to the targeted API, at least one of the multiple data validation levels being selected from the group of data validation levels consisting of schema level data validation, API specific syntactic data validation, and business application data validation.

20. A system capable of exchanging messages with a remote client application, the system comprising:

an application server hosting a server application;

an Application Programming Interface (API) server hosting an API capable of providing, to the remote client application, programmatic access to the server application, the API server being configured to;

receive a request message from the remote client application, the request message having an abstract message portion combined with an API-specific message portion, the abstract message portion having an abstract message payload and the API-specific message portion having an extended message payload including a request to perform an activity; and

perform the activity requested in the extended message payload, the activity performed by calling the server application;

wherein the system is in an electronic trading system, wherein the API-specific message portion has an identified schema definition specific to the API and the API is responsive to the API-specific message portion for multiple cases of purchasing and selling items via the electronic trading system;

wherein the application server and the API server each include a processor coupled to a memory; and

wherein the API facilitates communication between the server application and the remote client application.

21. The system of claim 20 wherein the abstract message portion is extensible for a plurality of different types of messages.

22. The system of claim 20 wherein the abstract message portion is extensible over a plurality of different protocols.

23. The system of claim 20, the multiple cases including at least one case selected from the group of cases consisting of listing an item, revising and relisting an item, and getting information about an item.

24. The system of claim 23 wherein the API is responsive to the API-specific message portion, such portion having an item data component and multiple data validation levels.

25. The system of claim 24 wherein the API-specific message portion further comprises an identified schema definition specific to the targeted API, at least one of the multiple data validation levels being selected from the group of data validation levels consisting of schema level data validation, API specific syntactic data validation, and business application data validation.