JP2013145436A - Control apparatus for api, control method for api and program - Google Patents

Abstract

PROBLEM TO BE SOLVED: To provide a control apparatus enabling systems with different specifications to use a common API.SOLUTION: A control apparatus includes: storage means for storing necessity information that shows necessity of first conversion for converting transmission information from a processor into an input format for an API and necessity of second conversion for converting output information from the API into an input format for the processor, upon associating the information with an identifier for identifying the processor or a user of the processor; first conversion means for, when receiving the transmission information including the identifier from the processor, referring to the necessity information corresponding to the identifier, and transmitting the transmission information to the API after converting it into the input format for the API if the first conversion for the transmission information is necessary, or transmitting the transmission information to the API if the first conversion for the transmission information is unnecessary; and second conversion means for, when receiving the output information from the API, transmitting the output information to the processor after converting it into the input format for the processor if the second conversion for the output information is necessary, or transmitting the output information to the processor if the second conversion for the output information is unnecessary.

Description

  The present invention relates to an API (Application Program Interface) control device, an API control method, and a program.

  Currently, various APIs are known (see Patent Document 1). The API is used when developing or modifying an application.

JP 2009-244976 A

  For example, when a system (hereinafter referred to as “system B”) having a specification different from that of the system A is connected to a system using an existing API (hereinafter referred to as “system A”), the system B is, for example, a system Due to the difference in the code system from A, there is a possibility that the existing API used by the system A cannot be used as it is.

  In this case, a new API having the same function as the existing API and adapted to the specification of the system B (for example, the code system of the system B) is created, and the new API is incorporated into the system A.

  For this reason, the development cost associated with the development and implementation of a new API, the length of time required for system integration, and the complexity of managing the application configuration due to the creation of a plurality of APIs having similar functions arise. .

  For this reason, there has been a problem that a technique for enabling use of a common API even in systems with different specifications is desired.

  An object of the present invention is to provide an API control device, an API control method, and a program that can solve the above-described problems.

The API control device of the present invention includes:
An API control device that controls communication between an API and a processing device that transmits transmission information for operating the API,
The necessity of the first conversion processing for converting the transmission information into the input format for the API and the necessity of the second conversion processing for converting the output information from the API into the input format for the processing device are indicated. Storage means for storing necessity information in association with an identifier for identifying the processing device or a user of the processing device;
When the transmission information including the identifier is received from the processing device, the necessity information corresponding to the identifier included in the transmission information among the necessity information needs the first conversion process for the transmission information. The transmission information is converted into the API input format and transmitted to the API, and the corresponding necessity information indicates that the first conversion process is not necessary for the transmission information. First conversion means for transmitting the transmission information to the API;
When the output information is received from the API, the output information is converted into an input format for the processing device when the corresponding necessity information indicates that the second conversion processing is necessary for the output information. And second conversion means for transmitting the output information to the processing device when the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information. .

The API control method of the present invention includes:
An API control method in an API control device that controls communication between an API and a processing device that transmits transmission information for operating the API,
The necessity of the first conversion processing for converting the transmission information into the input format for the API and the necessity of the second conversion processing for converting the output information from the API into the input format for the processing device are indicated. A storage step of storing necessity information in a storage unit in association with an identifier for identifying the processing device or a user of the processing device;
When the transmission information including the identifier is received from the processing device, the necessity information corresponding to the identifier included in the transmission information among the necessity information needs the first conversion process for the transmission information. The transmission information is converted into the API input format and transmitted to the API, and the corresponding necessity information indicates that the first conversion process is not necessary for the transmission information. A first conversion step of transmitting the transmission information to the API;
When the output information is received from the API, the output information is converted into an input format for the processing device when the corresponding necessity information indicates that the second conversion processing is necessary for the output information. And a second conversion step of transmitting the output information to the processing device when the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information. .

The program of the present invention is stored in a computer.
Necessity of first conversion processing for converting transmission information for operating API into the input format for API, and necessity of second conversion processing for converting output information from API into input format for processing device And a storage procedure for storing necessity information representing the storage device in association with an identifier for identifying the processing device or a user of the processing device;
When the transmission information including the identifier is received from the processing device, the necessity information corresponding to the identifier included in the transmission information among the necessity information needs the first conversion process for the transmission information. The transmission information is converted into the API input format and transmitted to the API, and the corresponding necessity information indicates that the first conversion process is not necessary for the transmission information. A first conversion procedure for transmitting the transmission information to the API;
When the output information is received from the API, the output information is converted into an input format for the processing device when the corresponding necessity information indicates that the second conversion processing is necessary for the output information. A second conversion procedure for transmitting the output information to the processing device when the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information. Let

  According to the present invention, it is possible to use a common API even in systems having different specifications.

It is the block diagram which showed the control apparatus 100 for API of 1st Embodiment of this invention. It is a figure showing an example of API correspondence table 10a. It is the figure which showed an example of the conversion type | formula table 10b. 4 is a flowchart for explaining an operation of setting necessity information, availability information, and a conversion formula in the table storage unit 1. It is a flowchart for demonstrating operation | movement when an API call request | requirement is received. It is a flowchart for demonstrating operation | movement when a return value is received. It is the figure which showed the control apparatus for API which consists of the table memory | storage part 1 and the difference absorption management parts 21 and 22. It is the block diagram which showed 100A of API control apparatuses of 2nd Embodiment of this invention. It is the figure which showed an example of the API name table 10c.

  Embodiments of the present invention will be described below with reference to the drawings.

(First embodiment)
FIG. 1 is a block diagram showing an API control device 100 according to the first embodiment of the present invention.

  The API control device 100 communicates with the service system 200 and the cooperation systems 301 to 30m (where m is an integer equal to or greater than 1).

  The service system 200 includes APIs 201 to 20n. In this embodiment, n = 2. Note that n is not limited to 2, and can be appropriately changed as long as it is an integer of 1 or more. Each of the APIs 201 and 202 executes a process assigned to itself by executing a program that defines the process assigned to itself.

  Hereinafter, the name of the API 201 is “F_API” and the name of the API 202 is “G_API”.

  The service system 200 is connected to the user terminal 400 used by the user of the service system 200, and causes the user terminal 400 to use the APIs 201 and 202.

  Each of the cooperation systems 301 to 30m is an example of a processing device.

  In this embodiment, it is assumed that the cooperation systems 301 to 30m are managed by different companies. The cooperation systems 301 to 30m may be managed by the same company without being managed by separate companies, or may be managed by an individual or the like.

  Each of the cooperation systems 301 to 30m is added with an identifier for identifying the own system or a user of the own system.

  As the identifier, for example, an ID (hereinafter referred to as “company ID”), a password, an IP (Internet Protocol) address of the own system, or a MAC ( Media Access Control) address is used.

  In the present embodiment, a company ID is used as an identifier. In the following, it is assumed that the company ID “aaa” is added to the linkage system 301 and the company ID “bbb” is added to the linkage system 302. Moreover, in this embodiment, since the cooperation systems 301-30m are each managed by a different company, company ID functions also as an identifier for identifying the cooperation systems 301-30m.

  Each of the cooperation systems 301 to 30m transmits an API call request for using the API in the service system 200 to the API control device 100.

  The API call request is an example of transmission information for using the API in the service system 200.

  In the present embodiment, the API call request includes the name of the API to be called (hereinafter “target API”) and a parameter (call value) processed by the target API.

  Note that the company ID of the system (cooperation system) that transmitted the API call request may be added to the API call request. In the following, it is assumed that the company ID is added to the API call request.

  For example, the API 201 has a function of performing processing for registering the price of a product specified by a designated product number (product model number) in a database, and the cooperation system 301 to which the company ID “aaa” is added is the API 201. When the price 1050 yen (including tax) of the product with the product model number S-001 is registered in the database, the API call request transmitted by the cooperation system 301 is “F_API (aaa, S-001, 1050)”. .

  In the API call request “F_API (aaa, S-001, 1050)”, “F_API” is the name (identification information) of the target API, and “aaa” is the company ID of the API call request source (cooperative system). Thus, “S-001, 1050” is a parameter (call value).

  The API control device 100 controls communication between the APIs 201 and 202 and the cooperation systems 301 to 30m.

  The API control device 100 includes an access control unit 101, a WebAPI-GW (gateway) 102, and an administrator input unit 103. The WebAPI-GW 102 includes a table storage unit 1 and an information control unit 2. The information control unit 2 includes differential absorption management units 21 and 22.

  The access control unit 101 performs authentication for each of the cooperation systems 301 to 30m and controls access to the WebAPI-GW102. Note that the authentication performed by the access control unit 101 is executed by a known method (for example, verification of a company ID or an IP (Internet Protocol) address).

  The WebAPI-GW 102 receives an API call request from the cooperation system that is permitted to be accessed by the access control unit 101.

  For example, the Web API-GW 102 converts the API call request format into the input format of the target API, and transmits the converted API call request to the target API.

  Further, for example, the WebAPI-GW 102 refers to a return value (return value) from a target API that has executed processing in response to an API call request, as a cooperation system (hereinafter referred to as a “transmission source cooperation system”) of the API call request transmission source. ) Input format and send the converted return value to the source linkage system.

  Note that the return value from the target API is an example of output information from the target API.

  The table storage unit 1 serves as both storage means and holding means.

  The table storage unit 1 stores an API correspondence table and a conversion formula table.

  In the API correspondence table, availability information and necessity information are described in association with the company ID.

  The availability information represents availability of each of the APIs 201 and 202 by the cooperation system for each of the cooperation systems 301 to 30m.

  Necessity information includes necessity / unnecessity of a conversion process (hereinafter referred to as “first conversion process”) for an API call request from each of the cooperation systems 301 to 30m, and a return value output from the target API in response to the API call request. The necessity of the conversion process (hereinafter referred to as “second conversion process”).

  The conversion formula table describes a conversion formula that defines the first conversion process and a conversion formula that defines the second conversion process.

  FIG. 2 is a diagram showing an example of the API correspondence table 10a. In FIG. 2, the number of APIs is two or more.

  In FIG. 2, usable 10a1 or unusable 10a2 is shown for each API such as API 201 and 202 for each company ID, that is, for each linked system. Usable 10a1 and unavailable 10a2 are examples of availability information.

  The availability information shown in FIG. 2 indicates that the cooperation system 301 identified by the company ID “aaa” can use the API 201 (F_API) and API 202 (G_API), and is identified by the company ID “bbb”. 302 indicates that the API 201 (F_API) cannot be used, but the API 202 (G_API) can be used.

  Further, in FIG. 2, conversion required 10a3 or conversion rejection 10a4 is shown for a combination in which use 10a1 is indicated among combinations of company ID (cooperation system) and API.

  As information attached to the conversion request 10a3, a conversion code 10a31 for specifying a conversion expression for converting a call value such as a parameter in an API call request, or a conversion code for specifying a conversion expression for converting a return value 10a32 is shown. The conversion requirement 10a3, the conversion failure 10a4, the conversion code 10a31, and the conversion code 10a32 are examples of the necessity information.

  FIG. 3 is a diagram showing an example of the conversion formula table 10b.

  In FIG. 3, “aaa_f_001 = price parameter ÷ 105%” is shown as a conversion expression corresponding to “aaa_f_001” which is an example of the conversion code 10a31, and as a conversion expression corresponding to “aaa_f_002” which is an example of the conversion code 10a32. “Aaa_f — 002 = normal registration code: 1 → 10”.

  The conversion formula “aaa_f — 001 = price parameter ÷ 105%” represents a conversion method for converting an API call request into an input format for the target API.

  The conversion formula “aaa_f — 002 = normal registration code: 1 → 10” represents a conversion method for converting the return value from the target API into the input format of the transmission source cooperation system.

  The information control unit 2 refers to the table storage unit 1 and controls an API call request and a return value from the API.

  The difference absorption management unit 21 is an example of a first conversion unit.

  For example, when the difference absorption management unit 21 receives an API call request from any of the cooperation systems 301 to 30m, the necessity / unnecessity corresponding to the company ID included in the API call request in the necessity information in the table storage unit 1. When the information (hereinafter referred to as “relevant necessity information”) indicates that the first conversion process is necessary for the API call request, the API call request is converted into an input format for the target API and the target When the corresponding necessity information indicates that the first conversion process is not necessary for the API call request, the API call request is transmitted to the target API.

  The difference absorption management unit 22 is an example of a second conversion unit.

  For example, when the difference absorption management unit 22 receives a return value from the target API, and the corresponding necessity information indicates that the second conversion process is necessary for the return value, the difference absorption management unit 22 displays the return value in cooperation with the transmission source. When it is converted into the input format for the system and transmitted to the transmission source cooperation system, and the corresponding necessity information indicates that the second conversion processing is not necessary for the return value, the return value is sent to the transmission source cooperation system. Send.

  The administrator input unit 103 is an example of a setting unit.

  The administrator input unit 103 accepts input of a company ID, necessity information, availability information, and conversion formula by an administrator of the API control device 100 (hereinafter simply referred to as “administrator”), and the necessity information and availability information. The conversion formula is set in the table storage unit 1 in association with the company ID.

  Next, the operation will be described.

  FIG. 4 is a flowchart for explaining an operation of setting necessity information, availability information, and a conversion formula in the table storage unit 1.

  When there is an application for using the API in the service system 200 in the cooperation system, the administrator determines a difference in specifications between the cooperation system in which the application for use is made and an API in the service system 200 (for example, a difference in code system). ) Is input to the administrator input unit 103 together with the company ID.

  When the manager input unit 103 receives the necessity information, the availability information, and the conversion formula together with the company ID (step S401), the manager input unit 103 sets the necessity information, the availability information, and the conversion formula in the table storage unit 1 in association with the company ID. (Step S402). Hereinafter, it is assumed that the API correspondence table 10a illustrated in FIG. 2 and the conversion formula table 10b illustrated in FIG. 3 are stored in the table storage unit 1.

  FIG. 5 is a flowchart for explaining the operation when an API call request is received.

  For example, when the cooperation system 301 transmits an API call request “F_API (aaa, S-001, 1050)” to the API control device 100, the access control unit 101 sets the company ID “aaa” in the API call request. In step S501, the cooperative system 301 is authenticated.

  When the access control unit 101 obtains an authentication result that prohibits the linkage system 301 from accessing the WebAPI-GW 102, the access control unit 101 transmits error information to the linkage system 301.

  On the other hand, when the access control unit 101 obtains an authentication result that allows the cooperation system 301 to access the WebAPI-GW 102, the access control unit 101 sends an API call request “F_API (aaa, S-001, 1050)” to the difference absorption management unit 21. Output to.

  Upon receiving the API call request “F_API (aaa, S-001, 1050)”, the difference absorption management unit 21 is indicated as the target API in the API call request and the company ID “aaa” indicated in the API call request. The availability information (hereinafter referred to as “applicability information”) corresponding to the combination of API 201 (F_API) (hereinafter referred to as “target combination”) is read from the API correspondence table 10a (step S502).

  When the corresponding availability information indicates the availability 10a1 (step S503), the difference absorption management unit 21 determines that the target API (API 201) is available in the cooperation system 301.

  On the other hand, when the corresponding availability information indicates the unusable 10a2 (step S503), the difference absorption management unit 21 determines that the target API (API 201) is unusable in the linkage system 301.

  If the difference absorption management unit 21 determines that it cannot be used, the difference absorption management unit 21 transmits error information to the cooperation system 301 (transmission source cooperation system) via the access control unit 101 (step S504).

  In this example, since the corresponding availability information indicates the availability 10a1, the difference absorption management unit 21 determines that the availability is possible.

  If the difference absorption management unit 21 determines that it can be used, the necessity information (corresponding necessity information) corresponding to the target combination (in this example, the combination of the company ID “aaa” and the API 201 (F_API)) Read from the correspondence table 10a (step S505).

  If the corresponding necessity information does not indicate the conversion failure 10a4 or the call value 10a31 (step S506), the difference absorption management unit 21 calls the API call request “F_API (aaa, S-001, 1050)”. Is transmitted to the API 201 (F_API) which is the target API as it is (step S507).

  On the other hand, if the corresponding necessity information does not indicate the conversion rejection 10a4 and indicates the call value 10a31 (step S506), the difference absorption management unit 21 converts the conversion formula corresponding to the call value 10a31 to the conversion formula table 10b. (Step S508).

  In this example, since the corresponding necessity information indicates “call value: aaa_f_001” 10a31, the difference absorption management unit 21 reads the conversion formula “aaa_f_001 = price parameter ÷ 105%” from the conversion formula table 10b.

  Subsequently, the difference absorption management unit 21 sends an API call request “F_API (aaa, S-001, 1050)” to the target API (API 201) according to the read conversion formula “aaa_f — 001 = price parameter ÷ 105%”. The API call request “F_API (aaa, S-001, 1000)” corresponding to the input format is converted (step S509).

  The conversion formula “aaa_f — 001 = price parameter ÷ 105%” is, for example, a specification in which the cooperation system 301 inputs the price of the product including tax, whereas the API 201 excludes the price of the product. In the situation where the specification is to be registered, it is used to convert the tax-included price (“1050” in the API call request) in the cooperation system 301 into the tax-excluded price used in the API 201.

  Subsequently, the difference absorption management unit 21 transmits an API call request “F_API (aaa, S-001, 1000)” to the API 201 that is the target API (step S510).

  When the API 201 in the service system 200 receives the API call request “F_API (aaa, S-001, 1000)”, the API 201 executes a process of registering the price 1000 yen (excluding tax) of the product with the product model number S-001 in the database. To do.

  When the process ends, the API 201 transmits a return value (processing result) set with the API call request transmission source (in this example, the affiliated system 301) as the destination to the difference absorption management unit 22.

  In the present embodiment, the API 201 outputs, as a return value, a normal registration code “1” indicating that normal registration has been performed by the API 201.

  If the API 201 cannot execute the process according to the API call request, the API 201 transmits error information in which the API call request transmission source is set as the destination to the difference absorption management unit 22. When receiving the error information, the difference absorption management unit 22 transmits the error information to the destination set in the error information via the access control unit 101.

  FIG. 6 is a flowchart for explaining the operation when a return value is received.

  When the difference absorption management unit 22 receives the return value, the target API (API 201 in this example) that is the transmission source of the return value, the cooperation system (in this example, the cooperation system 301) that is the destination of the return value, Necessity information corresponding to the combination (that is, corresponding necessity information) is read from the API correspondence table 10a (step S601).

  If the corresponding necessity information indicates the conversion failure 10a4 or does not indicate the return value 10a32 (step S602), the difference absorption management unit 22 uses the return value as it is as the destination set in the return value. Transmission is performed via the access control unit 101 (step S603).

  On the other hand, if the corresponding necessity information does not indicate the conversion rejection 10a4 and indicates the return value 10a32 (step S602), the difference absorption management unit 22 sets the conversion formula corresponding to the return value 10a32 to the conversion formula table 10b. (Step S604).

  In this example, since the corresponding necessity information indicates “return value: aaa_f — 002” 10a32, the difference absorption management unit 22 reads the conversion formula “aaa_f — 002 = normal registration code: 1 → 10” from the conversion formula table 10b.

  Subsequently, the difference absorption management unit 22 sets the return value “1” according to the input format at the destination set as the return value in accordance with the read conversion formula “aaa_f — 002 = normal registration code: 1 → 10”. The return value is converted to “10” (step S605).

  Note that the conversion formula “aaa_f — 002 = normal registration code: 1 → 10”, for example, the normal registration code is set to “1” in the API 201, whereas the normal registration code is set to “10” in the linkage system 301. In the set situation, it is used to convert the normal registration code “1” in the API 201 into the normal registration code “10” in the linkage system 301.

  Subsequently, the difference absorption management unit 22 transmits the return value “10” to the destination (cooperation system 301) set as the return value via the access control unit 101 (step S606).

  Upon receiving the return value, the cooperation system 301 that is the destination set in the return value sends the processing result corresponding to the return value to the cooperation system 301 or a user terminal (not shown) connected to the cooperation system 301. To display.

  Next, the effect of this embodiment will be described.

  According to the present embodiment, the table storage unit 1 stores necessity information in association with the company ID.

  When the difference absorption management unit 21 receives an API call request from any of the cooperation systems 301 to 30m, if the corresponding necessity information indicates that the first conversion process is required for the API call request, the API is requested. When the call request is converted into an input format for the target API and transmitted to the target API, and the corresponding necessity information indicates that the first conversion process is not necessary for the API call request, the API call request is To the target API.

  When the difference absorption management unit 22 receives the return value from the target API, if the corresponding necessity information indicates that the second conversion process is necessary for the return value, the difference absorption management unit 22 uses the return value for the transmission source cooperation system. When the corresponding necessity information indicates that the second conversion process is unnecessary for the return value, the return value is sent to the source cooperation system. To do.

  Therefore, when the API call request format does not correspond to the input format for the target API, the API call request is converted into a format corresponding to the input format for the target API and transmitted to the target API. .

  In addition, when the format of the return value from the target API does not correspond to the input format of the transmission source cooperation system, the return value is converted into a format according to the input format of the transmission source cooperation system, and the transmission source cooperation Sent to the system.

  Therefore, the API control device 100 can absorb the difference in specifications between the API and each linkage system for each linkage system. Therefore, even in a system (cooperation system) having a different specification from the API in the service system 200, the API can be used.

  Note that the above-described effects can also be achieved by an API control device including the table storage unit 1 and the difference absorption management units 21 and 22.

  FIG. 7 is a diagram illustrating an API control device including the table storage unit 1 and the difference absorption management units 21 and 22.

  In the present embodiment, the table storage unit 1 uses a first conversion method (conversion formula) for converting an API call request into an input format for the target API for an API call request that requires the first conversion process. The second conversion method (conversion formula) for storing the return value that needs to be stored and converting the return value into the input format for the cooperation system that is the transmission destination is stored.

  The difference absorption management unit 21 converts the API call request into the input format for the target API according to the first conversion method when the necessity information indicates that the first conversion process is necessary for the API call request.

  When the corresponding necessity information indicates that the second conversion process is necessary for the return value, the difference absorption management unit 22 converts the return value into the input format for the cooperation system as the transmission destination according to the second conversion method. Convert.

  For this reason, by appropriately setting the first conversion method and the second conversion method, the API call request can be appropriately converted into the input format for the target API, and the return value is for the cooperation system as the transmission destination. Can be converted to the input format.

  Further, in the present embodiment, the table storage unit 1 stores the availability information in association with the company ID.

  When the difference absorption management unit 21 receives an API call request from any of the cooperation systems 301 to 30m, in a situation where the corresponding availability information represents the availability of the target API by the source of the API call request, the corresponding necessity information When the API conversion request indicates that the first conversion process is necessary, the API call request is converted into an input format for the target API and transmitted to the target API, and the corresponding necessity information indicates the API call. If the request indicates that the first conversion process is not necessary, the API call request is transmitted to the target API.

  For this reason, it becomes possible to restrict | limit use of API by a cooperation system.

  In this embodiment, the administrator input unit 103 receives necessity information, availability information, and a conversion formula together with a company ID, and associates the necessity information, availability information, and conversion formula with the company ID in the table storage unit 1. Set.

  For this reason, it is possible to change the setting (information) in the table storage unit 1 without modifying the cooperation systems 301 to 30m and the APIs 201 and 202, so that even in a system (cooperation system) having different specifications from the API, It becomes possible to use API.

  Note that the WebAPI-GW 102 illustrated in FIG. 1 may be realized by a computer. In this case, the computer reads and executes a program recorded on a recording medium such as a CD-ROM (Compact Disk Read Only Memory) readable by the computer, thereby executing the table storage device 1, the difference absorption management unit 21, and the like. 22 functions. The recording medium is not limited to the CD-ROM and can be changed as appropriate.

  Further, the API control device 100 may be configured by a plurality of devices. For example, each unit included in the API control device 100 may be provided as an independent device.

(Second Embodiment)
Next, a second embodiment of the present invention will be described.

  FIG. 8 is a block diagram showing an API control device 100A according to the second embodiment of the present invention.

  In FIG. 8, the same components as those shown in FIG. Hereinafter, the API control device 100A shown in FIG. 8 will be described focusing on differences from the API control device 100 shown in FIG.

  In the first embodiment illustrated in FIG. 1, each cooperation system transmits an API call request using an API name (for example, F_API) in the service system 200.

  On the other hand, in the second embodiment, even if each cooperative system transmits an API call request using an API name (name unique to the local cooperative system) different from the API name in the service system 200, the service system The API in 200 becomes available.

  In the API control device 100A shown in FIG. 8, a table storage unit 1A is used instead of the table storage unit 1 shown in FIG. 1, and a differential absorption management unit 21A is used instead of the differential absorption management 21 shown in FIG. A differential absorption management unit 22A is used instead of the differential absorption management 22 shown in FIG.

  The table storage unit 1A is an example of a storage unit, a holding unit, and a storage unit.

  The table storage unit 1A stores an API name table 10c in addition to the API correspondence table 10a and the conversion formula table 10b in the table storage unit 1.

  FIG. 9 is a diagram showing an example of the API name table 10c.

  In FIG. 9, the API name 10c1 indicated in the API call request from each cooperation system and the API name 10c2 in the service system 200 associated with the API are associated with each other.

  For example, the API name “P_API” indicated in the API call request from the cooperation system 301 of the company ID “aaa” is changed to the name “F_API” assigned to the API 201 in the service system 200 associated with the P_API. Is associated.

  Also, the API name “Q_API” indicated in the API call request from the cooperation system 301 of the company ID “aaa” is changed to the name “G_API” assigned to the API 202 in the service system 200 associated with the Q_API. Is associated.

  The difference absorption management unit 21A is an example of a first conversion unit.

  For example, when receiving the API call request “P_API (aaa, S-001, 1050)” whose target API is P_API from the cooperation system 301, the difference absorption management unit 21A receives the API call request “P_API (aaa, S-001). , 1050) ”, and holds the copy, and refers to the API name table 10c to change the target API indicated in the API call request from“ P_API ”to“ F_API ”associated with P_API. Change to

  Subsequently, the difference absorption management unit 21A determines the company ID “aaa” indicated in the changed API call request “F_API (aaa, S-001, 1050)” and the F_API indicated as the target API in the API call request. Applicability information corresponding to the combination (target combination) with (API 201) is read from the API correspondence table 10a, and thereafter operates in the same manner as the difference absorption management unit 21 (see FIG. 5).

  The difference absorption management unit 22A is an example of a second conversion unit.

  For example, when the difference absorption management unit 21A receives an API call request with the target API P_API after the difference absorption management unit 21A receives a return value from the F_API (API 201), the difference absorption management unit 21A receives an API call request from the difference absorption management unit 21A. A copy of “P_API (aaa, S-001, 1050)” is acquired. This copy is used as “call request information” indicating that the difference absorption management unit 21A has received an API call request with the target API as P_API.

  Subsequently, the difference absorption management unit 22A uses the method used by the difference absorption management unit 22 when the corresponding necessity information in the table storage unit 1A indicates that the second conversion process is necessary for the return value. In the same manner, the return value is converted into an input format for the cooperation system 301 that transmitted the API call request. Thereafter, the difference absorption management unit 22A transmits the conversion result to the cooperation system 301 as a return value from the P_API indicated by the call request information as the target API.

  For example, the difference absorption management unit 22A attaches label information indicating that the conversion result is a return value from P_API to the conversion result, and transmits the conversion result to which the label information is attached to the cooperation system 301.

  On the other hand, when the difference necessity management information in the table storage unit 1A indicates that the second conversion process is not necessary for the return value, the difference absorption management unit 22A uses the return request as the target API. As a return value from the P_API shown as

  For example, the difference absorption management unit 22A attaches label information indicating that the return value is a return value from P_API to the return value, and transmits the return value to which the label information is attached to the cooperation system 301. .

  According to the present embodiment, the table storage unit 1A stores an API name (identification information) in the service system 200 and another API name (identification information) in association with each other.

  When the difference absorption management unit 21A receives an API call request having another API name from the cooperation system, when the corresponding necessity information indicates that the first conversion process is necessary for the API call request, The API call request is converted into an input format for the target API specified by the name associated with the name of another API, and is transmitted to the target API. When it indicates that one conversion process is unnecessary, the API call request is transmitted to the target API specified by the name associated with the name of another API.

  Therefore, even if each cooperative system transmits an API call request using an API name different from the API name in the service system 200, the API in the service system 200 can be used.

  In the present embodiment, the difference absorption management unit 22A, after the difference absorption management unit 21A receives an API call request having another API name from the cooperation system, is associated with the name of the other API. When a return value is received from the target API specified by, the following processing is performed.

  When the corresponding necessity information indicates that the second conversion process is necessary for the return value, the difference absorption management unit 22A uses the return value as the input format for the cooperation system that is the source of the API call request. And the conversion result is transmitted to the cooperative system as a return value from the other API.

  On the other hand, when the corresponding necessity information indicates that the second conversion process is not necessary for the return value, the difference absorption management unit 22A uses the return value as a return value from the other APIs to the cooperation system. Output.

  For this reason, the sender of the API call request (sender cooperation system) can recognize that the return value from the API requested by the API call request has arrived.

  In the above embodiments, the availability information and the necessity information are managed by the API conversion table 10a. However, the availability information and the necessity information may be managed by separate tables.

  Further, the availability information and the necessity information may be stored in separate storage units. In this case, the storage unit that stores the availability information is an example of the holding unit, and the storage unit that stores the necessity information is an example of the storage unit.

  In the second embodiment, the API name table 10c is stored in the table storage unit 1A. However, the API name table 10c may be stored in a storage unit different from the table storage unit 1A. In this case, a storage unit that stores the API name table 10c is an example of a storage unit.

  In each of the above embodiments, the conversion formula is not limited to a formula that converts a numeric value to another numeric value. For example, a formula that converts text to a numeric value, a formula that converts a numeric value to text, and a binary number that is converted to decimal Or an expression for changing one API requested by the API call request to a plurality of APIs on the service system side, or an expression for changing the name of the API indicated in the API call request.

  A plurality of conversion formulas may be used for one combination of the cooperation system and the API in the service system. For example, the conversion formula used for conversion may be switched depending on the time zone.

  In each of the above embodiments, the conversion necessity 10a3 and the conversion failure 10a4 are used. However, the conversion necessity 10a3 and the conversion failure 10a4 may be omitted. In this case, the presence / absence of the call value 10a31 and the presence / absence of the conversion expression corresponding to the call value 10a31 mean the necessity of the first conversion process, and the presence / absence of the return value 10a32 and the presence / absence of the conversion expression corresponding to the return value 10a32 are the second. This means whether or not conversion processing is necessary. That is, the presence / absence of the call value 10a31, the presence / absence of a conversion expression corresponding to the call value 10a31, the presence / absence of a return value 10a32, and the presence / absence of a conversion expression corresponding to the return value 10a32 function as necessity information.

  Note that the WebAPI-GW 102 illustrated in FIG. 8 may be realized by a computer. In this case, the computer functions as the table storage device 1A and the difference absorption management units 21A and 22A by reading and executing a program recorded on a computer-readable recording medium.

  Further, the API control device 100A may be configured by a plurality of devices. For example, each unit included in the API control device 100A may be provided as an independent device.

  In each embodiment described above, the illustrated configuration is merely an example, and the present invention is not limited to the configuration.

100, 100A API control device 101 Access control unit 102 WebAPI-GW
103 administrator input unit 1, 1A table storage unit 2 information control unit 21, 21A, 22, 22A difference absorption management unit 200 service system 201-20n API
301 ~ 30m cooperation system

Claims (8)

An API control device that controls communication between an API and a processing device that transmits transmission information for operating the API,
The necessity of the first conversion processing for converting the transmission information into the input format for the API and the necessity of the second conversion processing for converting the output information from the API into the input format for the processing device are indicated. Storage means for storing necessity information in association with an identifier for identifying the processing device or a user of the processing device;
When the transmission information including the identifier is received from the processing device, the necessity information corresponding to the identifier included in the transmission information among the necessity information needs the first conversion process for the transmission information. The transmission information is converted into the API input format and transmitted to the API, and the corresponding necessity information indicates that the first conversion process is not necessary for the transmission information. First conversion means for transmitting the transmission information to the API;
When the output information is received from the API, the output information is converted into an input format for the processing device when the corresponding necessity information indicates that the second conversion processing is necessary for the output information. And second conversion means for transmitting the output information to the processing device when the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information. API control device. The API control device according to claim 1,
The storage means stores a first conversion method for converting the transmission information into the input format for the API for transmission information that requires the first conversion process, and the second conversion process is required. For the output information, store the second conversion method for converting the output information into the input format for the processing device,
The first conversion means converts the transmission information into the input format for the API according to the first conversion method when the necessity information indicates that the first conversion processing is necessary for the transmission information. And
The second conversion means converts the output information into an input format for the processing device according to the second conversion method when the necessity information indicates that the second conversion processing is necessary for the output information. API controller that converts to The API control device according to claim 1 or 2,
A holding unit that holds whether or not the API can be used by the processing device in association with the identifier;
When the first conversion unit receives the transmission information including the identifier from the processing device, the availability information corresponding to the identifier included in the transmission information is used by the processing device in the API. When the corresponding necessity information indicates that the first conversion process is necessary for the transmission information in the situation indicating permission, the transmission information is converted into the API input format and transmitted to the API. An API control device that transmits the transmission information to the API when the corresponding necessity information indicates that the first conversion process is unnecessary for the transmission information. The API control device according to claim 1 or 2,
Storage means for storing the identification information of the API and the identification information of another API in association with each other;
When the first conversion means receives the transmission information having the identification information of the other API and the identifier from the processing device, the first conversion process needs to be performed on the transmission information. In the case of indicating that there is, the transmission information is converted into an API input format specified by the identification information associated with the identification information of the other API and transmitted to the API. When the information indicates that the first conversion process is not necessary for the transmission information, the transmission information is transmitted to an API specified by the identification information associated with the identification information of the other API. API control device. The API control device according to claim 4,
The second conversion unit is associated with the identification information of the other API after the first conversion unit receives the transmission information including the identification information of the other API and the identifier from the processing device. When the output information is received from the API specified by the identification information, if the corresponding necessity information indicates that the second conversion process is necessary for the output information, the output information is used for the processing device. When the conversion result is input, the conversion result is transmitted to the processing device as a return value from the other API, and the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information An API control device that transmits the output information to the processing device as a return value from the other API. The API control device according to any one of claims 1 to 5,
An API control device further comprising: a setting unit that receives the necessity information and the identifier, and sets the necessity information in the storage unit in association with the identifier. An API control method in an API control device that controls communication between an API and a processing device that transmits transmission information for operating the API,
The necessity of the first conversion processing for converting the transmission information into the input format for the API and the necessity of the second conversion processing for converting the output information from the API into the input format for the processing device are indicated. A storage step of storing necessity information in a storage unit in association with an identifier for identifying the processing device or a user of the processing device;
When the transmission information including the identifier is received from the processing device, the necessity information corresponding to the identifier included in the transmission information among the necessity information needs the first conversion process for the transmission information. The transmission information is converted into the API input format and transmitted to the API, and the corresponding necessity information indicates that the first conversion process is not necessary for the transmission information. A first conversion step of transmitting the transmission information to the API;
When the output information is received from the API, the output information is converted into an input format for the processing device when the corresponding necessity information indicates that the second conversion processing is necessary for the output information. And a second conversion step of transmitting the output information to the processing device when the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information. Control method for API. On the computer,
Necessity of first conversion processing for converting transmission information for operating API into the input format for API, and necessity of second conversion processing for converting output information from API into input format for processing device And a storage procedure for storing necessity information representing the storage device in association with an identifier for identifying the processing device or a user of the processing device;
When the transmission information including the identifier is received from the processing device, the necessity information corresponding to the identifier included in the transmission information among the necessity information needs the first conversion process for the transmission information. The transmission information is converted into the API input format and transmitted to the API, and the corresponding necessity information indicates that the first conversion process is not necessary for the transmission information. A first conversion procedure for transmitting the transmission information to the API;
When the output information is received from the API, the output information is converted into an input format for the processing device when the corresponding necessity information indicates that the second conversion processing is necessary for the output information. A second conversion procedure for transmitting the output information to the processing device when the corresponding necessity information indicates that the second conversion processing is unnecessary for the output information. Program to let you.

Images