API and business language schema design framework for message exchanges

Patent metadata

Field	Value
Publication number	US-9965338-B2
Application number	US-201715488747-A
Country	US
Kind code	B2
Filing date	Apr 17, 2017
Priority date	Nov 24, 2003
Publication date	May 8, 2018
Grant date	May 8, 2018

Abstract

Systems, methods and media are provided for facilitating an exchange of messages between a remote client application and a server system the server system, the server system being capable of supporting a plurality of application program interfaces (APIs) that includes a targeted API. In one example, a method includes receiving a plurality of request messages generated by the remote client application, each request message requesting an activity to be performed by the targeted API, with respect to an associated application, and comprising at least one data component common to each of the plurality of request messages and selected from a group comprising a predetermined required level of detail, an error language component and a version identifier, and a request component including a reusable identified schema definition.

First claim

What is claimed is:

1. 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 (APIs) that includes a targeted API, 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 the targeted API, with respect to an associated application, and comprising:
at least one data component common to each of the plurality of request messages and selected from a group comprising a predetermined required level of detail, an error language component and a version identifier, and
a request component including a reusable identified schema definition.

2. The method of claim 1 , wherein the at least one data component is common to each of the plurality of request messages and is selected from a group comprising a predetermined required level of detail, an error language component and a version identifier.

3. The method of claim 1 , wherein each of the plurality of APIs is configured to generate a response message that is sent to the remote client application, responsive to a received request message.

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

5. A system for 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 (APIs) that includes a targeted API, the system including:
processors; and
a memory storing instructions that, when executed by at least one processor among the processors, cause the system to perform operations comprising, at least:
receiving a plurality of request messages generated by the remote client application, each request message requesting an activity to be performed by the targeted API, with respect to an associated application, and comprising:
at least one data component common to each of the plurality of request messages and selected from a group comprising a predetermined required level of detail, an error language component and a version identifier, and
a request component including a reusable identified schema definition.

6. The system of claim 5 , wherein the operations further comprise performing version and error check operations.

7. The system of claim 5 , wherein the operations further comprise generating a response message that is sent from the server system to the remote client application.

8. The system of claim 7 , wherein the generating of the response message includes generating an acknowledgement, a timestamp, a correlation identifier, error data and version data.

9. A non-transitory machine-readable storage device comprising instructions which, when executed by a machine, cause the machine to perform operations of facilitating an exchange of messages in a trading system between a remote client application and a server system, the server system being capable of supporting a plurality of application program interfaces, the operations comprising, at least:
receiving a plurality of request messages generated by the remote client application, each request message requesting an activity to be performed by the targeted API, with respect to an associated application, and comprising:
at least one data component common to each of the plurality of request messages and selected from a group comprising a predetermined required level of detail, an error language component and a version identifier, and
a request component including a reusable identified schema definition.

10. The machine-readable storage device of claim 9 , the operations further comprising performing version and error check operations.

11. The machine-readable storage device of claim 9 , the operations further comprising generating a response message that is to be sent from the server system to the remote client application.

12. The machine-readable storage device of claim 11 , the operations further comprising generating an acknowledgement, a timestamp, a correlation identifier, error data and version data.

Assignees

• Ebay Inc

Inventors

• Ahmed Zahid N
• Cohen Alon
• Kao Daniel Tsun
• Tanaka Ray
• Yue Gary
• Avalani Bhaven

Classifications

• G06Q30/08

  Auctions · CPC title

• H04L67/10

  in which an application is distributed across nodes in the network (software deployment G06F8/60; multiprogramming arrangements G06F9/46) · CPC title

• G06F2209/541

  Client-server · CPC title

• G06F9/54 Primary

  Interprogram communication · CPC title

• G06F9/451

  Execution arrangements for user interfaces · CPC title