API and Business Language Schema Design Framework for Message Exchanges

Patent metadata

Field	Value
Publication number	US-2023106120-A1
Application number	US-202218063588-A
Country	US
Kind code	A1
Filing date	Dec 8, 2022
Priority date	Nov 24, 2003
Publication date	Apr 6, 2023
Grant date	—

Abstract

In one example, a server system facilitates an exchange of messages with a remote client application. An Application Program Interface (API) receives a first request message and a second request message, wherein the first request message includes a first data payload defined by a common definition and including a first payload data, the first payload defined by a first schema definition. The second request message includes a second data payload defined by the common definition and a second payload data, wherein the second payload is defined by a second schema definition different than the first schema definition. In response to receiving the first request message, the API transmits a first response message, and in response to receiving the second request message, the API transmits a second response.

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 supporting a plurality of application program interfaces (APIs) that includes a targeted API, the method comprising:
receiving a request message generated by the remote client application, the request message requesting an activity to be performed by the targeted API, the request message comprising a data component common to a plurality of request messages, the data component including a version identifier that is included in each of the plurality of request messages.

2 . The method of claim 1 , wherein the data component conforms to a reusable schema.

3 . The method of claim 2 , wherein the reusable schema is identified by the version identifier.

4 . The method of claim 1 , further comprising, in response to receiving the request message, generating a response message.

5 . The method of claim 4 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including at least one of:
a time stamp; an acknowledgement; a correlation identifier; versioning information; or a build component.

6 . The method of claim 5 , wherein the acknowledgement comprises an acknowledgement code.

7 . The method of claim 5 , wherein the correlation identifier identifies the request message as being correlated to the response.

8 . The method of claim 5 , wherein the versioning information identifies an API version supported by the server system.

9 . The method of claim 4 , wherein the response message comprises error information.

10 . The method of claim 9 , wherein the error information comprises an error code and a severity information.

11 . A non-transitory computer storage media comprising computer executable instructions that, when executed by at least one processor, perform operations comprising:
receiving a request message generated by a remote client application, the request message requesting an activity to be performed by a targeted API, the request message comprising a data component common to a plurality of request messages, the data component including a version identifier that is included in each of the plurality of request messages.

12 . The non-transitory computer storage media of claim 11 , wherein the data component conforms to a reusable schema.

13 . The non-transitory computer storage media of claim 12 , wherein the reusable schema is identified by the version identifier.

14 . The non-transitory computer storage media of claim 11 , further comprising, in response to receiving the request message, generating a response message.

15 . The non-transitory computer storage media of claim 14 , wherein the response message comprises a second data component common to a plurality of response messages, the second data component including at least one of:
a time stamp; an acknowledgement; a correlation identifier; versioning information; or a build component.

16 . The non-transitory computer storage media of claim 15 , wherein the acknowledgement comprises an acknowledgement code.

17 . The non-transitory computer storage media of claim 15 , wherein the correlation identifier identifies the request message as being correlated to the response.

18 . The non-transitory computer storage media of claim 15 , wherein the versioning information identifies an API version supported by a server system.

19 . The non-transitory computer storage media of claim 14 , wherein the response message comprises error information.

20 . The non-transitory computer storage media of claim 19 , wherein the error information comprises an error code and a severity information.

Assignees

• Ebay Inc

Inventors

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

Classifications

• H04L67/10

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

• H04L67/02

  based on web technology, e.g. hypertext transfer protocol [HTTP] · CPC title

• G06F9/451

  Execution arrangements for user interfaces · CPC title

• G06F9/547

  Remote procedure calls [RPC]; Web services · CPC title

• G06F9/54 Primary

  Interprogram communication · CPC title