CN113485824A - API (application programming interface) interface management method of integrated operation and maintenance platform - Google Patents
API (application programming interface) interface management method of integrated operation and maintenance platform Download PDFInfo
- Publication number
- CN113485824A CN113485824A CN202110444801.7A CN202110444801A CN113485824A CN 113485824 A CN113485824 A CN 113485824A CN 202110444801 A CN202110444801 A CN 202110444801A CN 113485824 A CN113485824 A CN 113485824A
- Authority
- CN
- China
- Prior art keywords
- interface
- server
- api
- data
- request
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F9/00—Arrangements for program control, e.g. control units
- G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
- G06F9/46—Multiprogramming arrangements
- G06F9/50—Allocation of resources, e.g. of the central processing unit [CPU]
- G06F9/5005—Allocation of resources, e.g. of the central processing unit [CPU] to service a request
- G06F9/5011—Allocation of resources, e.g. of the central processing unit [CPU] to service a request the resources being hardware resources other than CPUs, Servers and Terminals
Abstract
The invention discloses an API (application program interface) management method of an integrated operation and maintenance platform, which comprises the following steps of: establishing an API interface similar to RESTFUL style at a server; packaging interfaces of each system into a plurality of interface resources according to RESTFUL standard at a server, wherein the interface resources are distributed with unique resource identifiers URI and resource address URLs; when the server and the system carry out data interaction, the server schedules corresponding interface resources to be in butt joint with the system through the resource identifier URI and the resource address URL so as to acquire data of the system; and storing the data uploaded by the system into a database of the server, and calling the data from the database according to the request of the application layer. The invention solves the problem of non-standard unification of multiple interfaces of multiple systems, encapsulates the interfaces from each self-built system through a unified interface standard, applies, calls, updates and uses the interfaces according to the standard, effectively reduces the communication cost among technicians, avoids the trouble of debugging the interfaces back and forth, effectively improves the working efficiency and reduces the development cost.
Description
Technical Field
The invention relates to an API (application program interface) management method of an integrated operation and maintenance platform.
Background
The existing operation and maintenance platform integrates data from unit systems and carries out real-time updating, displaying and monitoring, but because each unit is a self-built system, interfaces among different systems are generally different, no matter data structures or acquisition modes, verification modes and the like, the problems of non-uniform data standards, disordered data sharing and the like exist, and when a new system is encountered, a corresponding interface standard protocol needs to be specially customized for the new system, so that the data of each system is very troublesome to be comprehensively docked.
Disclosure of Invention
In order to overcome the problems in the prior art, the invention discloses an API (application program interface) management method of an integrated operation and maintenance platform, which is realized by the following technical means:
the API interface management method of the integrated operation and maintenance platform comprises the following steps:
s01, establishing an API interface similar to RESTFUL style in the server;
packaging interfaces of each system into a plurality of interface resources according to RESTFUL standard at a server, wherein the interface resources are distributed with unique resource identifiers URI and resource address URLs;
s02, when the server interacts data with the system, the server dispatches corresponding interface resources to be in butt joint with the system through the resource identifier URI and the resource address URL to acquire the data of the system;
and S03, storing the data uploaded by the system into a database of the server, and calling the data from the database according to the request of the application layer.
In one or more embodiments of the present invention, the API data between the server and the system is interacted in JSON format.
In one or more embodiments of the invention, in step S02, the server performs data interaction with the system according to the timing task; the interface type of the system is preset, and the server schedules the corresponding interface resource to be in butt joint with the interface resource according to the interface type.
In one or more embodiments of the invention, in step S02, the server performs data interaction with the system according to the timing task; the server sends a query message to the system, obtains the interface type of the system according to the response of the system to the query message, and schedules the corresponding interface resource to be in butt joint with the interface resource according to the interface type.
In one or more embodiments of the present invention, in step S01, a login interface is set on the server, and the login interface is configured with an account apid and a public key for system login; in step S02, before initiating a request for calling the API interface, the system applies for a token from the login interface through the account number appid and the public key, and carries the token in subsequent service data to verify the validity of the API interface request.
In one or more embodiments of the present invention, in step S03, the data obtained through the API interface is cleaned and then stored, which includes the following steps:
s031, obtaining request transmission parameters, which include: signature, application ID, request time and message digest;
s032, acquiring request body transmission data, and determining whether the message digest of the request body is equal to the message digest of the request transmission parameter, if so, performing step S033;
s033, according to agreement between the server and the system, verifying whether a signature generated by the message digest of the account number apid, the token, the request body transmission data and the request time is equal to a signature of the request transmission parameter, and if so, executing the step S034;
s034, decrypting the message digest through a public key agreed by the two parties;
and S035, decoding through a URLDecoder to obtain the original data requested to be sent by the API.
In one or more embodiments of the present invention, the interface resource is edited by a form at the server side, and the edited interface resource is filed by a database, so as to perform a version rollback on the interface resource according to a request.
In one or more embodiments of the present invention, when an interface resource is called, the state, the number of calls, and the last call time of the interface resource are monitored and recorded, and an interface management log is generated accordingly.
The invention has the beneficial effects that: the problem of many interfaces of multisystem unified difficult problem that does not standardize is solved, encapsulate the interface standard that comes from building the system certainly of each unit through unified interface management platform, according to standard application, call, update, use the interface, not only can file the edit of interface every time, carry out the version rollback at any time, and the unified management of interface effectively reduces the communication cost between the technical staff moreover, effectively promotes work efficiency, need not to make a round trip to debug the interface like in the past again, greatly promotes the efficiency of development, reduce development cost.
Drawings
Fig. 1 is a schematic diagram of an API data stream architecture.
FIG. 2 is a screenshot of an API interface setup form.
Detailed Description
The scheme of the present application is further described below with reference to the accompanying figures 1 to 2:
the API interface management method of the integrated operation and maintenance platform comprises the following steps:
s01, establishing an API interface similar to RESTFUL style in the server;
packaging interfaces of each system into a plurality of interface resources according to RESTFUL standard at a server, wherein the interface resources are distributed with unique resource identifiers URI and resource address URLs;
s02, when the server interacts data with the system, the server dispatches corresponding interface resources to be in butt joint with the system through the resource identifier URI and the resource address URL to acquire the data of the system;
and S03, storing the data uploaded by the system into a database of the server, and calling the data from the database according to the request of the application layer.
Referring to fig. 1, a data acquisition subsystem (a self-built system of each unit) mainly completes data acquisition work (structured and unstructured) of the whole integrated operation and maintenance platform. As a basic system of the platform, the data acquisition subsystem provides data base and data guarantee for other subsystems of the platform through data acquisition work. The collection working principle is as follows: the data acquisition subsystem provides a service interface for the outside through the processes of acquisition, data storage and data processing of various data sources (such as video monitoring, asset details of operation and maintenance services, network security equipment and the like) and an API (application programming interface) interface management method. Fig. 1 is a technical architecture diagram of an integrated operation and maintenance platform, in which an acquisition layer, a storage layer, a processing layer, a resource task scheduling layer, and a service interface layer belong to the working category of a data acquisition subsystem.
Preferably, the API data between the server and the system is interacted in JSON format.
Preferably, in step S02, the server performs data interaction with the system according to the timing task, and in order to acquire and schedule the corresponding interface resource, one of the following two approaches may be used: firstly, an interface type of a system is preset, and a server schedules corresponding interface resources to be in butt joint with the interface type according to the interface type. Secondly, the server sends out an inquiry message to the system, obtains the interface type of the system according to the response of the system to the inquiry message, and schedules the corresponding interface resource to be in butt joint with the interface resource according to the interface type.
Preferably, in step S01, a login interface is set on the server, and the login interface is configured with an account apid and a public key for system login; in step S02, before initiating a request for calling the API interface, the system applies for a token from the login interface through the account number appid and the public key, and carries the token in subsequent service data to verify the validity of the API interface request.
Preferably, in step S03, the method for cleaning and storing the data obtained through the API interface includes the following steps:
s031, obtaining request transmission parameters, which include: signature, application ID, request time and message digest;
s032, acquiring request body transmission data, and determining whether the message digest of the request body is equal to the message digest of the request transmission parameter, if so, performing step S033;
s033, according to agreement between the server and the system, verifying whether a signature generated by the message digest of the account number apid, the token, the request body transmission data and the request time is equal to a signature of the request transmission parameter, and if so, executing the step S034;
s034, decrypting the message digest through a public key agreed by the two parties;
and S035, decoding through a URLDecoder to obtain the original data requested to be sent by the API.
Preferably, the interface resources are edited through a form at the server side, and the edited interface resources are filed through a database and used for rolling back the versions of the interface resources through the SVN according to the request.
Preferably, when the interface resource is called, the state, the calling number and the last calling time of the interface resource are monitored and recorded, and an interface management log is generated accordingly. Namely, the program of the interface resource is automatically recorded and stored in the service database of the data acquisition system once called, the records are called interface management logs, the interface logs recorded in the database can be consulted in a list form through the log management module, and the parameters of the docking system, the docking address, the port, log warning (namely calling state: normal and abnormal) and docking use time of each interface call are checked for information monitoring.
The invention solves the problem of non-standard unification of multiple interfaces of multiple systems, encapsulates the self-built system from each unit through the interface standard of the unified interface management platform, applies, calls, updates and uses the interfaces according to the standard, not only can file each edition of the interfaces and roll back the versions at any time, but also effectively reduces the communication cost among technicians by the unified management of the interfaces, effectively improves the working efficiency, does not need to debug the interfaces back and forth as before, greatly improves the development efficiency and reduces the development cost.
The above preferred embodiments should be considered as examples of the embodiments of the present application, and technical deductions, substitutions, improvements and the like similar to, similar to or based on the embodiments of the present application should be considered as the protection scope of the present patent.
Claims (8)
1. The API management method of the integrated operation and maintenance platform is characterized by comprising the following steps:
s01, establishing an API interface similar to RESTFUL style in the server;
packaging interfaces of each system into a plurality of interface resources according to RESTFUL standard at a server, wherein the interface resources are distributed with unique resource identifiers URI and resource address URLs;
s02, when the server interacts data with the system, the server dispatches corresponding interface resources to be in butt joint with the system through the resource identifier URI and the resource address URL to acquire the data of the system;
and S03, storing the data uploaded by the system into a database of the server, and calling the data from the database according to the request of the application layer.
2. The API management method of the integrated operation and maintenance platform according to claim 1, wherein: API data between the server and the system are interacted in a JSON format.
3. The API management method of the integrated operation and maintenance platform according to claim 1, wherein: in step S02, the server performs data interaction with the system by the timed task; the interface type of the system is preset, and the server schedules the corresponding interface resource to be in butt joint with the interface resource according to the interface type.
4. The API management method of the integrated operation and maintenance platform according to claim 1, wherein: in step S02, the server performs data interaction with the system by the timed task; the server sends a query message to the system, obtains the interface type of the system according to the response of the system to the query message, and schedules the corresponding interface resource to be in butt joint with the interface resource according to the interface type.
5. The API management method of the integrated operation and maintenance platform according to claim 1, wherein: in step S01, a login interface is set on the server, and the login interface is configured with an account apid and a public key for system login; in step S02, before initiating a request for calling the API interface, the system applies for a token from the login interface through the account number appid and the public key, and carries the token in subsequent service data to verify the validity of the API interface request.
6. The API management method of the integrated operation and maintenance platform according to claim 5, wherein: in step S03, the data obtained through the API interface is cleaned and stored, which includes the following steps:
s031, obtaining request transmission parameters, which include: signature, application ID, request time and message digest;
s032, acquiring request body transmission data, and determining whether the message digest of the request body is equal to the message digest of the request transmission parameter, if so, performing step S033;
s033, according to agreement between the server and the system, verifying whether a signature generated by the message digest of the account number apid, the token, the request body transmission data and the request time is equal to a signature of the request transmission parameter, and if so, executing the step S034;
s034, decrypting the message digest through a public key agreed by the two parties;
and S035, decoding through a URLDecoder to obtain the original data requested to be sent by the API.
7. The API management method of the integrated operation and maintenance platform according to claim 1, wherein: and editing the interface resources through the form at the server side, and filing the edited interface resources through a database for rolling back the versions of the interface resources according to the request.
8. The API management method of the integrated operation and maintenance platform according to claim 1, wherein: when the interface resource is called, the state, the calling times and the last calling time of the interface resource are monitored and recorded, and an interface management log is generated.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202110444801.7A CN113485824A (en) | 2021-04-24 | 2021-04-24 | API (application programming interface) interface management method of integrated operation and maintenance platform |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202110444801.7A CN113485824A (en) | 2021-04-24 | 2021-04-24 | API (application programming interface) interface management method of integrated operation and maintenance platform |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN113485824A true CN113485824A (en) | 2021-10-08 |
Family
ID=77933468
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202110444801.7A Pending CN113485824A (en) | 2021-04-24 | 2021-04-24 | API (application programming interface) interface management method of integrated operation and maintenance platform |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN113485824A (en) |
Cited By (3)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN114721845A (en) * | 2022-04-14 | 2022-07-08 | 广州有信科技有限公司 | Multi-tenant restful API interface management method and device |
| CN115883668A (en) * | 2022-11-29 | 2023-03-31 | 广发银行股份有限公司 | Traffic scheduling platform |
| CN117687623B (en) * | 2023-12-29 | 2024-04-26 | 上海宽睿信息科技有限责任公司 | API code-free automatic receiving method and device |
Citations (7)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN104008135A (en) * | 2014-05-07 | 2014-08-27 | 南京邮电大学 | Multi-source heterogeneous database fusion system and data query method thereof |
| WO2016188290A1 (en) * | 2015-05-27 | 2016-12-01 | 阿里巴巴集团控股有限公司 | Safety authentication method, device and system for api calling |
| CN108958711A (en) * | 2017-05-22 | 2018-12-07 | 北京京东尚科信息技术有限公司 | A kind of implementation method and device of interface platform |
| CN109446252A (en) * | 2018-09-05 | 2019-03-08 | 中国电力科学研究院有限公司 | A kind of unified access method and system for power grid regulation |
| CN110458528A (en) * | 2019-08-07 | 2019-11-15 | 上海数讯信息技术有限公司 | A kind of full-service configuration management platform based on CMDB operation management |
| CN110764815A (en) * | 2019-09-26 | 2020-02-07 | 北京网聘咨询有限公司 | Web API project issuing method and device |
| CN112612629A (en) * | 2020-12-28 | 2021-04-06 | 广东广宇科技发展有限公司 | Method and system for realizing component type data interface |
-
2021
- 2021-04-24 CN CN202110444801.7A patent/CN113485824A/en active Pending
Patent Citations (7)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN104008135A (en) * | 2014-05-07 | 2014-08-27 | 南京邮电大学 | Multi-source heterogeneous database fusion system and data query method thereof |
| WO2016188290A1 (en) * | 2015-05-27 | 2016-12-01 | 阿里巴巴集团控股有限公司 | Safety authentication method, device and system for api calling |
| CN108958711A (en) * | 2017-05-22 | 2018-12-07 | 北京京东尚科信息技术有限公司 | A kind of implementation method and device of interface platform |
| CN109446252A (en) * | 2018-09-05 | 2019-03-08 | 中国电力科学研究院有限公司 | A kind of unified access method and system for power grid regulation |
| CN110458528A (en) * | 2019-08-07 | 2019-11-15 | 上海数讯信息技术有限公司 | A kind of full-service configuration management platform based on CMDB operation management |
| CN110764815A (en) * | 2019-09-26 | 2020-02-07 | 北京网聘咨询有限公司 | Web API project issuing method and device |
| CN112612629A (en) * | 2020-12-28 | 2021-04-06 | 广东广宇科技发展有限公司 | Method and system for realizing component type data interface |
Cited By (4)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN114721845A (en) * | 2022-04-14 | 2022-07-08 | 广州有信科技有限公司 | Multi-tenant restful API interface management method and device |
| CN115883668A (en) * | 2022-11-29 | 2023-03-31 | 广发银行股份有限公司 | Traffic scheduling platform |
| CN115883668B (en) * | 2022-11-29 | 2023-10-20 | 广发银行股份有限公司 | Telephone traffic scheduling platform |
| CN117687623B (en) * | 2023-12-29 | 2024-04-26 | 上海宽睿信息科技有限责任公司 | API code-free automatic receiving method and device |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN111245916B (en) | Service calling method, service arranging method and device based on micro-service gateway | |
| CN111181727A (en) | Open API full life cycle management method based on micro service | |
| CN113485824A (en) | API (application programming interface) interface management method of integrated operation and maintenance platform | |
| CN111752799A (en) | Service link tracking method, device, equipment and storage medium | |
| CN107193668B (en) | Calling method and system of interface server | |
| US20070033284A1 (en) | System server for data processing with multiple clients and a data processing method | |
| CN105072297B (en) | The speech-sound intelligent adapting system of call center | |
| CN110138876B (en) | Task deployment method, device, equipment and platform | |
| CN110516454A (en) | Exchange method, system, device and the computer readable storage medium of more equipment | |
| CN106276457A (en) | The method of elevator data management | |
| CN100446510C (en) | System and method for implementing business integrating between interprises | |
| CN112188013B (en) | Customer service method based on real-time information, storage medium and server | |
| CN107154982B (en) | Method and system for auditing log records | |
| CN112542002A (en) | Car renting system control method and device | |
| CN110807184A (en) | Method for intelligently recording screen and acquiring behavior data of computer and mobile terminal user | |
| CN114416314B (en) | Service arrangement method based on API gateway | |
| CN113220480B (en) | Distributed data task cross-cloud scheduling system and method | |
| CN106339757A (en) | Elevator data management system | |
| CN112835635A (en) | Equipment replacement method, device, system, server and storage medium | |
| CN111666178A (en) | Safety monitoring method and system | |
| CN117573396B (en) | Distributed workflow event processing method, device and medium | |
| CN113067951B (en) | Terminal communication management method and device, computer equipment and readable storage medium | |
| CN117078212B (en) | Business process processing method and device, electronic equipment and storage medium | |
| CN114172804B (en) | Alliance chain separation deployment method, system, medium and electronic equipment | |
| CN116737834B (en) | Real-time synchronization system for dealer multi-tenant database and table division scene data |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination |