TWM606342U - Multi-endpoint and cross-industry cross-organization unified specification pattern application platform - Google Patents

Abstract

A multi-endpoint and cross-industry and cross-organization unified application programming interface (APPLICATION INTERFACE, API) platform, which can solve the problem that it may take a long time to complete the entire adjustment process and the product name and query parameters are different from each other. In order to provide flexibility for business adjustments and increase the way for third-party operators to obtain API-related request item parameters, it is planned to plan and design an API to provide a list of request item parameters and business items to compare with each other, and provide a flexible API for request item parameters and business items Cross-reference list query service to minimize the frequency of requesting item parameters to be adjusted in API specifications. Business API service providers can modify and adjust related parameters and provide related information flexibly.

Description

Multi-endpoint and cross-industry and cross-organization unified application programming interface platform

This creation is about the technical field of computers, especially about a multi-endpoint and cross-industry and cross-organization unified application program interface platform.

If the business development of the current domestic, domestic and foreign industries need to provide external application services, they have gradually adopted the application programming interface (API) as the connection method, and most of the API service providers (such as financial, insurance systems, etc.) ) Is to directly provide API entry for external third-party providers (such as application developers or website service providers) to connect. If third-party providers need to connect with API service providers due to application needs, they must first obtain and study Paper or electronic file specification documents, and then develop the application program connected with API.

When a third-party business uses its terminal device to connect to the API provided by the API service provider’s computer system, it often needs to read the specification document first to understand the relevant request parameters to be used before making an inquiry. However, most APIs provide data in response to business needs, so related request parameters often need to be added, removed, and adjusted due to business needs adjustments. When this happens, the specification file needs to be changed, and the notification of the change It became a problem.

In addition, it will take some time for the specification file to be released to the developer to obtain the update information, and then to make relevant adjustments. It may also be possible that the third party cannot obtain the data correctly due to the update error of the specification file. Complete the adjustment process and extend the time for program development and testing by third-party operators.

In addition, when multiple API service providers use the same specification to provide APIs, there will be uncertainty due to different business projects introduced by each API service provider, or different ways of storing query parameters within each API service provider. Quantity or different query parameters. Under this premise, it is difficult to uniformly determine the mutual comparison of all shared business item names and query parameters in the same API specification for use by all API service providers.

In view of the above problems, the purpose of this creation is to provide a multi-endpoint and cross-industry and cross-organization unified specification style application program interface platform, which can solve the problem that it may take a long time to complete the entire adjustment process, as well as the product name and query parameters. Compare different issues to provide flexibility for business adjustments, and increase the way for third-party operators to obtain API-related request item parameters. It is planned to plan and design an API to provide a list of request item parameters and business items to compare against each other, and provide a flexible API for requests A list query service that compares project parameters and business projects to minimize the frequency of requesting project parameters in API specifications. Business API service providers can modify and adjust relevant parameters and provide relevant information flexibly.

The style of this creation is to provide a multi-endpoint and cross-industry and cross-organization unified application program interface platform, which includes: A project parameter list creation and management module, one of the third-party terminal equipment of a plurality of third-party operator terminal devices uses the project parameter list application interface of the project parameter list creation and management module to send the The creation and management module of the project parameter list requests to obtain a project parameter list, and receives the project parameter list, wherein the project parameter list includes a plurality of project parameters; 1. Identify each corresponding bank-side item parameter list module, and receive the request to obtain the item parameter list sent by the establishment and management module of the item parameter list to request the identification of each corresponding bank-side item parameter list module to lead a bank The terminal item parameter list application program interface, link to one of the bank terminal computer systems of a plurality of bank terminal computer systems corresponding to an item parameter URL, to guide the bank terminal item parameter list application program interface of the bank terminal computer system, and send The request for obtaining the item parameter list is sent to the bank computer system, the item parameter list responded by the bank computer system is received, and the item parameter list is sent to the creation and management module of the item parameter list. The request to obtain the project parameter list includes the project parameter URL; A corresponding business side establishment and management module, the third-party terminal equipment uses the corresponding business side establishment and management module one of the business side application program interfaces to communicate the corresponding business side establishment and management module According to the project parameters, request to obtain a business-side application program interface data, and receive the business-side application program interface data, wherein each of the plural business-side data of the business-side application interface data corresponds to each of the project parameters ;as well as 1. Identify each bank's business side module, receive the request to obtain the application interface data of the business side sent by the establishment and management module of the corresponding business side, and link the bank side computer system corresponding to a business side URL to Direct a bank-side business application program interface of the bank-side computer system, and send a request for obtaining the business-side application program interface data to the bank-side computer system, and receive the business response from the bank-side computer system Application interface data, and send the business application interface data to the corresponding business creation and management module, where the request to obtain the business application interface data includes the project parameters and the business data URL .

In order to enable those who are familiar with the art in the technical field of this creation to have a better understanding of this creation, the following specifically enumerates the preferred embodiments of this creation, together with the attached drawings, to explain in detail the content of the creation and the desired effect .

The following content of the manual will describe an API that can provide requested item parameters. In the form of LIST, the requested item parameters and related business item names are provided, so that the provision of requested item parameters can increase with the expansion of business items. Three-party operators only need to call the API of the request item parameter list to obtain all the request item parameters, and then use the relevant request item parameters to the corresponding API to perform actions such as querying product information.

Figure 1 is a block diagram of a unified specification style API platform with multiple endpoints and cross-industry and cross-organization. In FIG. 1, several third-party operators use their third-party terminal devices 22, 24 through a multi-endpoint and cross-industry and cross-institution unified API platform 10 to use several bank computer systems 26 as API service providers. , 32, and 34. For example, the bank computer system 26 provides a bank-side item parameter list API 28 and a bank-side business API 30.

The unified specification style API platform 10 includes a project parameter list and business side authorization establishment and management module 12, a project parameter list establishment and management module 14, a corresponding business side establishment and management module 16, and an identification each Corresponding to a bank-side item parameter list module 18 and a bank-side business side module 20.

One of the terminal devices 22 and 24 of the third-party operator logs in the unified specification style API platform 10 to request the project parameter list and the business-side authorization creation and management module 12 to use the item parameter list API and the unified specification style API platform 10 The authorization of the business API, the project parameter list and the business authorization when the third-party operator of the third-party operator terminal device 22, 24 that has been logged in is verified as a legitimate user in the project parameter list and the business authorization creation and management module 12 The establishment and management module 12 responds to the authorization to use the item parameter list API and the business API to the terminal equipment 22, 24 of the third party.

One of the terminal devices 22 and 24 of the third-party operator uses the project parameter list API of the project parameter list creation and management module 14 to request the project parameter list creation and management module 14 to obtain a project parameter list. The item parameter list creation and management module 14 receives the item parameter list sent by the item parameter list module 18 that identifies each corresponding bank, and transmits the item parameter list to the third-party terminal equipment 22, which requests the item parameter list. twenty four. Among them, the project parameter list includes several project parameters.

Identify each corresponding bank item parameter list module 18 receives the request to obtain the item parameter list sent by the item parameter list creation and management module 14 to request to identify each corresponding bank item parameter list module 18 leads to a bank item Parameter list API 28. Identify each corresponding bank-end item parameter list module 18 to link one of the bank-end computer systems (such as the bank-end computer system 26) of the bank-end computer systems corresponding to a project parameter URL to guide the bank of the bank-end computer system 26 End item parameter list API 28, and send a request to obtain the item parameter list to the bank computer system 26.

When a third-party operator uses the third-party operator’s terminal equipment 22 and 24 via the unified specification style API platform 10 to use the bank-end computer system 26’s bank-end item parameter list API 28, the bank-end computer system 26 accepts the corresponding third-party operator’s terminal When a third-party operator of the equipment 22, 24 obtains a request for the item parameter list, the bank computer system 26 responds to the requested item parameter list to the unified specification style API platform 10, and the unified specification style API platform 10 identifies each corresponding bank The terminal item parameter list module 18 receives the item parameter list responded by the bank computer system 26, and transmits the item parameter list to the item parameter list creation and management module 14. Among them, the request for obtaining the project parameter list includes the project parameter URL.

One of the third-party terminal equipment 22, 24 uses the business side API of the corresponding business side establishment and management module 16 to request the corresponding business side establishment and management module 16 to obtain a business side based on the project parameters. API information. The establishment and management module 16 corresponding to the business side receives the business side API data transmitted by the business side module 20 that identifies each bank, and transmits the business side API data to the terminal device 22 of the third party that requests the business side API data. twenty four. Among them, each of the plural business data of the business API data corresponds to each of the project parameters.

The business side module 20 that identifies each bank receives the request to obtain the business side API data sent by the establishment and management module 16 of the corresponding business side. Identify each bank-end business side module 20 to link to one of the bank-end computer systems (such as the bank-end computer system 26) of the bank-end computer systems corresponding to a business side URL, so as to lead to one of the bank-end computer systems 26 Business API 30, and sends a request to obtain business API data to the bank computer system 26.

When a third-party operator uses the third-party operator’s terminal equipment 22 and 24 via the unified-standard style API platform 10 to use the bank-end computer system 26’s bank-end business API 30, the bank’s computer system 26 accepts the corresponding third-party operator’s terminal equipment In the case of a request from a third-party operator of 22 and 24 to obtain business API data, the bank computer system 26 responds to the requested business API data to the unified specification style API platform 10, and the unified specification style API platform 10 identifies each bank The business side module 20 receives the business side API data responded by the bank computer system 26, and transmits the business side API data to the corresponding business side establishment and management module 16. Among them, the request to obtain business-side API data includes the project parameters and the business-side data URL.

Figure 2 is a flow chart of the operation method of the multi-endpoint and cross-industry and cross-organization unified API platform. Refer to the system architecture of FIG. 1 when describing the process steps of FIG. 2.

Provide the service provider's bank with a parameter API defined by a uniform specification, and define the data format of its request and response, and the parameters required to send the request. Similarly, define the business-face API, and the relevant parameters required for its access, but need to be obtained through the parameter API, and define the data format of the business-face API response.

For example, suppose that a unified specification defines the bank-end item parameter list API for deposit product query parameters, and the bank-end business API of deposit product information responds to the business API data. The format is JSON format and a key/value (keyword) /Value) corresponding data type.

Bank A provides two APIs through the implementation of unified specifications, one API is the bank-side project parameter list API for deposit product query parameters, and one is the bank-side business API for deposit product information. The URL of the bank-side project parameter list API: https://hostname/api/v1.0.0/deposit/parameter/list, and the bank-side business API URL: https://hostname/api/v1.0.0/deposit.

Suppose that when using the bank-side project parameter list API for deposit product query parameters, query parameters are required. The query parameter name is depositType and the value is all. An example of a third-party provider when calling is as follows: https://hostname/api/v1.0.0/deposit/parameter/list?depositType=all The response content is as follows, JSON format, key/value correspondence, the value contained in the value is the query parameter of another deposit product information API { "Current Deposit": "demand", "Current Savings Deposit": "demandSaving", "Payroll Transfer Current Savings Deposit": "payrollTransfer", "Security Account Current Savings Deposit": "secDemandSaving", "Digital Deposit": "digital", "Comprehensive Deposit": "comprehensive" } After finding the relevant query parameters through the above API, use these query parameters on another deposit product information API.

Suppose that the query parameter name of the deposit product information API is depositNames, and the value is demand above. An example of a third-party provider's call is as follows: https://hostname/api/v1.0.0/deposit?depositNames= demand The response content is in a JSON format, with key/value correspondence, and contains business side data of demand deposit product information.

On the business side, if there is an increase or decrease in similar products in the future, the bank-end item parameter list API used for deposit product query parameters can be used to update product query parameters, reducing the need to adjust specifications or increase or decrease the number of APIs.

Assuming that Bank A adds the number of products in its business, Bank A only needs to adjust the back-end program, but it can still use the same two APIs, the same data format, and response parameter data through a unified specification, and the parameter data is only added The name of the project and the corresponding parameter is nothing more than: { "Current Deposit": "demand", "Current Savings Deposit": "demandSaving", "Payroll Transfer Current Savings Deposit": "payrollTransfer", "Security Account Current Savings Deposit": "secDemandSaving", "Digital Deposit": "digital", "Comprehensive Deposit": "comprehensive", "Check Deposit": "check", "Emerging Deposit Products": "new" } Two additional product parameters have been added. Bank A will notify cooperating third-party companies of the new business information through different channels. Third-party companies can still use the same API specifications to access new business data, which greatly reduces third parties The burden of the program that the industry needs to adjust.

As mentioned above, because the product types and names of different banks are not the same, it is impossible to set the query parameters of all products or adjust the specifications when the banking business changes. When all participating banks use this method to design the API, the bank only needs to adjust the program, and does not need to adjust the bank-side item parameter list API specifications and bank-side business API specifications for query parameters, and can provide relevant changed product information to Third-party operators, and third-party operators do not have to make too many program changes for a variety of different specifications.

In Figure 2, before a third-party operator wants to use the multi-endpoint and cross-industry and cross-organization unified API platform 10, the third-party operator must use the third-party terminal devices 22 and 24 to enter the unified API platform 10 to register. In order to obtain an account using the unified specification style API platform 10.

One of multiple third-party terminal devices 22, 24 logs into the unified specification style API platform 10 to request the use of project parameters from the item parameter list in the unified specification style API platform 10 and the establishment and management module 12 for business authorization Authorization of List API and Business API (Step S40).

When the project parameter list and the business-side authorization creation and management module 12 verify that the third-party operators of the logged-in third-party operator terminal devices 22 and 24 are legal users, the project parameter list and the business-side authorization creation and management module The group 12 responds to the authorization to use the item parameter list API and the business API to the terminal equipment 22, 24 of the third-party operator (step S42).

When a third-party operator wants to obtain a bank-side project parameter list from the unified specification style API platform 10, the logged-in third-party operator terminal equipment 22, 24 uses one of the project parameter list creation and management module 14 project parameter list API , To request a project parameter list from the creation and management module 14 of the project parameter list, where the project parameter list includes several project parameters in the above example (step S44).

The item parameter list creation and management module 14 sends a request to obtain the item parameter list to the identifying each corresponding bank item parameter list module 18 to request the identification of each corresponding bank item parameter list module 18 leads to a bank item The parameter list API 28, wherein the request to obtain the project parameter list includes a project parameter URL of one of the bank computer systems 26, 32, 34 (the project parameter URL described in the above example) (step S46).

By identifying each corresponding bank-side item parameter list module 18, link one of several bank-side computer systems 26, 32, and 34 corresponding to the item parameter URL of the request to obtain the item parameter list to guide the bank-side computer system 26, The bank-end item parameter list API 28 of 32 and 34, and the request for obtaining the item parameter list is sent to the bank-end computer system 26, 32, 34 (step S48).

When a third-party operator uses the third-party operator’s terminal equipment 22, 24 via the unified specification style API platform 10 to use the bank-end computer system 26, 32, 34 bank-end item parameter list API 28, the bank-end computer system 26, 32, 34 In the case of accepting the request of the third-party provider corresponding to the third-party terminal equipment 22, 24 to obtain the item parameter list, the bank computer system 26, 32, 34 responds to the requested item parameter list to the unified specification style API platform 10. The unified specification style API platform 10 identifies each corresponding bank item parameter list module 18 receives the item parameter list responded by the bank computer system 26, 32, 34, and transmits the item parameter list to the creation and creation of the item parameter list The management module 14, then the project parameter list creation and management module 14 transmits the response project parameter list to the logged-in third-party operator terminal equipment 22, 24 (step S50).

When a third-party operator wants to obtain the bank-side business API data from the unified specification style API platform 10, the logged-in third-party operator terminal equipment 22, 24 uses one of the business-face creation and management modules 16 of the corresponding business-face API , To request the establishment and management module 16 corresponding to the business plane to obtain a business plane API data, wherein each of the several business plane data of the business plane API data corresponds to each of the project parameters (step S52).

The establishment and management module 16 corresponding to the business side sends a request to obtain the API data of the business side to the identification module 20 of each bank side business side to request the identification of each bank side business side module 20 to lead a bank side business side API 30 , Where the request for obtaining business API data includes these project parameters and directed to one of the bank’s computer systems 26, 32, and 34 business data URL (such as the business data URL in the above example) (step S54).

One of several bank-side computer systems 26, 32, 34 linked to the business-side data URL corresponding to the request to obtain the business-side API data by identifying each bank-side business side module 20, to guide the bank-side computer system 26, 32, 34 of the bank-side business API 30, and send the request for obtaining the business-side API data to the bank computer system 26, 32, 34 (step S56).

When a third-party operator uses the bank-end computer system 26, 32, and 34 of the bank-end computer system 26, 32, 34 through the unified-standard style API platform 10 through the third-party operator’s terminal equipment 22, 24, the bank-end computer system 26, 32, 34 In the case of accepting the request of the third party corresponding to the third party terminal device 22, 24 to obtain business API data, the bank computer system 26, 32, 34 responds to the requested business API data to the unified specification API platform 10. , And the unified specification style API platform 10 identifies each bank business side module 20 receives the business side API data responded by the bank side computer systems 26, 32, 34, and transmits the business side API data to the establishment of the corresponding business side And the management module 16, and then the establishment and management module 16 corresponding to the business side sends the responded business side API data to the logged-in third-party operator terminal devices 22, 24 (step S58).

This authoring department provides a multi-endpoint and cross-industry and cross-organization unified specification style application program interface platform. Its characteristics are that it can solve the problem that it may take a long time to complete the entire adjustment process, and that the product name and query parameters are different from each other. Provide flexibility to cooperate with business adjustments, and increase the way for third-party operators to obtain API-related request item parameters. It is planned to plan and design an API to provide a list of request item parameters and business items to compare with each other, and provide a flexible API to request item parameters and business items to interact Check the list of services to help minimize the frequency of requesting item parameters to be adjusted in API specifications. Business API service providers can modify and adjust related parameters and provide relevant information flexibly.

Although this creation has been described above with reference to preferred specific examples and illustrative drawings, it should not be regarded as restrictive. Those familiar with the art make various modifications, omissions, and changes to its form and the content of specific examples, without departing from the scope of claims of this creation.

10: Unified specification style API platform 12: Project parameter list and business authorization establishment and management module 14: Creation and management module of project parameter list 16: Corresponding business establishment and management module 18: Identify each corresponding bank item parameter list module 20: Identify the business side modules of each bank 22: Terminal equipment of third-party operators 24: Terminal equipment of third-party operators 26: Bank-side computer system 28: Bank-side project parameter list API 30: Bank-side business API 32: Bank computer system 34: Bank-side computer system

Figure 1 is a block diagram of a unified specification style API platform with multiple endpoints and cross-industry and cross-organization. Figure 2 is a flow chart of the operation method of the multi-endpoint and cross-industry and cross-organization unified API platform.

10: Unified specification style API platform

12: Project parameter list and business authorization establishment and management module

14: Creation and management module of project parameter list

16: Corresponding business establishment and management module

18: Identify each corresponding bank item parameter list module

20: Identify the business side modules of each bank

22: Terminal equipment of third-party operators

24: Terminal equipment of third-party operators

26: Bank-side computer system

28: Bank-side project parameter list API

30: Bank-side business API

32: Bank computer system

34: Bank-side computer system

Claims (4)

A multi-endpoint and cross-industry and cross-organization unified specification style application program interface platform. Multiple third-party terminal devices log in to the unified specification style application programming interface platform. The uniform specification style application programming interface platform connects to multiple bank computer systems, The unified specification style application program interface platform includes: a project parameter list creation and management module, and one of the third-party operator terminal devices uses one of the project parameter list creation and management modules The project parameter list application program interface is used to request a project parameter list from the creation and management module of the project parameter list, and receive the project parameter list, where the project parameter list includes a plurality of project parameters; one identifies each corresponding bank item The parameter list module receives the request to obtain the parameter list of the item sent by the creation and management module of the parameter list of the item, to request the identification of each corresponding bank item parameter list module to guide a bank item parameter list application program interface , Link to one of the bank-side computer systems corresponding to a project parameter URL to guide the bank-side project parameter list application program interface of the bank-side computer system, and send a request to obtain the project parameter list To the bank computer system, receive the item parameter list responded by the bank computer system, and send the item parameter list to the creation and management module of the item parameter list, where the request for the item parameter list is obtained Including the project parameter URL; a corresponding business side establishment and management module, the third-party terminal equipment uses the corresponding business side establishment and management module one of the business side application program interfaces to communicate with the corresponding business side The creation and management module requests a business-side application interface data based on the project parameters, and receives the business-side application interface data, wherein each of the plural business-side data of the business-side application interface data corresponds to each Each of the project parameters; and a module that identifies each bank’s business side, and receives the data from the establishment and management module of the corresponding business side Send a request to obtain the application program interface data of the business, link the bank-side computer system corresponding to a business-side URL, to guide the bank-side business application program interface of the bank-side computer system, and send to obtain the business The request of the application program interface data is sent to the bank computer system, receives the business application interface data responded by the bank computer system, and sends the business application interface data to the corresponding business The establishment and management module, wherein the request for obtaining the interface data of the business side application program includes the project parameters and the business side data URL. The multi-endpoint and cross-industry and cross-organization unified application program interface platform described in claim 1 further includes a project parameter list and a business-side authorization creation and management module. The third-party terminal device logs into the Uniform specification style application programming interface platform to request the creation and management module of the project parameter list and business side authorization to use the project parameter list application programming interface and the business side application programming interface authorization, in the project parameter list and business The establishment and management module of the face authorization verifies that the third-party operator’s terminal device that has been logged in is a legitimate user, and the project parameter list and the establishment and management module authorized by the business face respond to the permission to use the project The parameter list application interface and the authorization of the business application interface to the terminal equipment of the third-party operator. The multi-endpoint and cross-industry and cross-institution unified application program interface platform described in claim 1, wherein the establishment and management module of the item parameter list will identify the corresponding bank item parameter list module sent The project parameter list is transmitted to the terminal device of the third-party operator. The multi-endpoint and cross-industry and cross-institution unified application program interface platform described in claim 1, wherein the establishment and management module of the corresponding business side will identify the business transmitted by each bank-end business side module The application program interface data is sent to the terminal device of the third party.

Images