API and business language schema design framework for message exchanges

• US 7,886,305 B2
• Filed: 04/30/2010
• Issued: 02/08/2011
• Est. Priority Date: 11/24/2003
• Status: Active Grant

• Current Assignee: eBay Inc.
• Original Assignee: eBay Inc.
• Inventors: Avalani, Bhaven, Yue, Gary, Tanaka, Ray, Kao, Daniel, Ahmed, Zahid, Cohen, Alon
• Primary Examiner(s): WU, QING YUAN
• Application Number:
  US12/771,981
• Publication Number:
  US 20100223633A1
• Time in Patent Office: 284 Days
• Field of Search: 719/313, 719/328, 719/330
• US Class Current: 719/313
• 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 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 an identified schema definition specific to the API;

parse and extract the abstract message payload and the extended message payload from the request message; and

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

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.

2. The system of claim 1 wherein the system is 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.

3. The system of claim 2, 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.

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

5. The system of claim 4, 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.

6. A non-transitory computer-readable storage device 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 an Application Programming Interface (API), providing programmatic access between a server application and a remote client application;

using an API server, receiving 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 an identified schema definition specific to the API;

parsing and extracting the abstract message payload and the extended payload from the request messages; and

performing the activity requested in the extended message payload.

7. The computer-readable storage device of claim 6, the operations being performed in an electronic trading system and the API being responsive to the API-specific message portion for multiple cases of purchasing and selling items via the electronic trading system.

8. The computer readable storage device of claim 7, 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.

9. The computer readable storage device of claim 7, the API being responsive to API-specific message portion having an item data component and multiple data validation levels.

10. The system of claim 9, the multiple data validation levels including at least one data validation level 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 method of facilitating an exchange of messages between a remote client application and a server, the method comprising:

receiving a request message from the remote client application in an Application Programming Interface (API) server;

the request message received by a targeted API;

the request message requesting an activity to be performed, and having an abstract message portion combined with an API-specific message portion;

wherein the abstract message portion has an abstract message payload and the API-specific message portion has an extended message payload including a request to perform an activity, and an identified schema definition specific to the targeted API;

parsing and extracting the abstract message payload and the extended message payload from the request message in the targeted API; and

performing the activity requested in the request message by calling one or more function calls in the server applications from the targeted API;

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

12. The method as set forth in claim 11, the method further comprising performing version and error check operations in the targeted API.

13. The method as set forth in claim 11, including generating a response message that is to be sent to the remote client application.

14. The method as set forth in claim 13, wherein generating a response message includes generating an acknowledgement, a timestamp, a correlation identifier, error data, and version data.

15. A non-transitory computer-readable storage device 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:

facilitating an exchange of messages between a remote client application and a server by receiving, in an Application Programming Interface (API) server, a request message from the remote client application;

the request message received by a targeted API;

the request message requesting an activity to be performed, and having an abstract message portion combined with an API-specific message portion;

wherein the abstract message portion has an abstract message payload and the API-specific message portion has an extended message payload including a request to perform an activity, and an identified schema definition specific to the targeted API;

parsing and extracting the abstract message payload and the extended message payload from the request message in the targeted API; and

performing the activity requested in the request message by calling one or more function calls in the server application from the targeted API;

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

16. The computer-readable storage device of claim 15, the operations further including performing version and error check operations in the targeted API.

17. The computer-readable storage device of claim 15, the operations further including generating a response message that is to be sent to the remote client application.

18. The computer-readable storage device of claim 17, wherein generating a response message includes generating an acknowledgement, a timestamp, a correlation identifier, error data, and version data.

19. A non-transitory computer-readable storage device 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 an Application Programming Interface (API), providing programmatic access between a server application and a remote client application;

using an API server, receiving 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 an identified schema definition specific to the API;

parsing and extracting the extended payload from the request message; and

performing the activity requested in the extended message payload.

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

an application server hosting a server application;

an Application Programming Interface (API) server hosting an API capable of providing, to a 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 an identified schema definition specific to the API;

parse and extract the extended payload from the request message; and

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

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

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