CN117492951A - 一种政务***对外接口的标准化管理方法 - Google Patents
一种政务***对外接口的标准化管理方法 Download PDFInfo
- Publication number
- CN117492951A CN117492951A CN202311435413.8A CN202311435413A CN117492951A CN 117492951 A CN117492951 A CN 117492951A CN 202311435413 A CN202311435413 A CN 202311435413A CN 117492951 A CN117492951 A CN 117492951A
- Authority
- CN
- China
- Prior art keywords
- interface
- version
- external
- government
- calling party
- 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
- 238000007726 management method Methods 0.000 title claims abstract description 30
- 238000000034 method Methods 0.000 claims abstract description 16
- 238000013507 mapping Methods 0.000 claims abstract description 15
- 238000012545 processing Methods 0.000 claims abstract description 14
- 230000008569 process Effects 0.000 claims abstract description 12
- 238000012544 monitoring process Methods 0.000 claims abstract description 8
- 238000012795 verification Methods 0.000 claims description 15
- 238000012827 research and development Methods 0.000 claims description 6
- 230000002159 abnormal effect Effects 0.000 claims description 4
- 238000013475 authorization Methods 0.000 claims description 3
- 238000011835 investigation Methods 0.000 abstract description 5
- 230000000739 chaotic effect Effects 0.000 abstract 1
- 238000011161 development Methods 0.000 description 15
- 238000012423 maintenance Methods 0.000 description 8
- 238000003032 molecular docking Methods 0.000 description 4
- 210000001503 joint Anatomy 0.000 description 3
- 238000011160 research Methods 0.000 description 3
- 238000010276 construction Methods 0.000 description 2
- 230000003993 interaction Effects 0.000 description 2
- 238000013024 troubleshooting Methods 0.000 description 2
- 230000009286 beneficial effect Effects 0.000 description 1
- 230000000694 effects Effects 0.000 description 1
- 238000012986 modification Methods 0.000 description 1
- 230000004048 modification Effects 0.000 description 1
- 230000035515 penetration Effects 0.000 description 1
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/48—Program initiating; Program switching, e.g. by interrupt
- G06F9/4806—Task transfer initiation or dispatching
- G06F9/4843—Task transfer initiation or dispatching by program, e.g. task dispatcher, supervisor, operating system
- G06F9/4881—Scheduling strategies for dispatcher, e.g. round robin, multi-level priority queues
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/30—Authentication, i.e. establishing the identity or authorisation of security principals
- G06F21/44—Program or device authentication
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- Software Systems (AREA)
- Physics & Mathematics (AREA)
- General Engineering & Computer Science (AREA)
- General Physics & Mathematics (AREA)
- Computer Security & Cryptography (AREA)
- Computer Hardware Design (AREA)
- Management, Administration, Business Operations System, And Electronic Commerce (AREA)
Abstract
本发明公开一种政务***对外接口的标准化管理方法，涉及接口管理技术领域。针对政务***对外接口可能存在冗余、重复或冲突的功能，代码重复、混乱和维护困难，接口升级和问题排查流程繁琐等一系列问题，采取技术方案为：预先采集政务***对外接口的接口调用方信息，进行接口调用方、接口和接口版本的标准化定义，并进一步定义接口调用方、接口和接口版本三者的映射关系；针对政务***提供的对外接口，设定统一入口和对外接口的通用处理流程；基于接口调用方、接口和接口版本三者的映射关系，通过统一入口和对外接口的通用处理流程实现接口鉴权、接口权限管理和接口监控。本发明可以实现政务***对外接口的高度标准化管理。
Description
技术领域
本发明涉及接口管理技术领域，具体的说是一种政务***对外接口的标准化管理方法。
背景技术
随着“互联网+政务服务”的深入，电子政务内外网、政务数据共享交换平台已经成为各级政府部门统筹推进数据共享的必要通道，各地区、各部门政务***之间的数据交互也越来越频繁。随着政务***不断建设完善，政务***对外接口的数量与复杂度不断上升，政务***对外接口在安全性、多版本兼容性、性能、稳定性方面的也面临着挑战。
在跨部门政务***功能对接工作中，常采用接口对接的形式进行数据交互，针对特定的功能需求开发相应的功能接口，编写功能接口文档提供给对接方，最后双方完成接口开发与对接工作。在政务***的开发建设中，不同研发人员对接开发的接口，在接口鉴权、记录日志、接口返回参数结构、接口对接文档编写风格等对接细节上都存在差异，没有将对外提供的接口做统筹管理，研发人员就无法直观的看到对外接口全局情况，因而导致对外接口可能存在冗余、重复或冲突的功能，代码重复、混乱和维护困难，接口升级和问题排查流程繁琐等一系列问题。
发明内容
本发明针对目前技术发展的需求和不足之处，提供一种政务***对外接口的标准化管理方法，将政务***对外接口进行统一的管理，解决对外接口开发过程中接口开发规范和流程缺乏一致性、对外接口开发维护、问题排查困难等实际问题。
本发明的一种政务***对外接口的标准化管理方法，解决上述技术问题采用的技术方案如下：
一种政务***对外接口的标准化管理方法，其包括如下步骤：
预先采集政务***对外接口的接口调用方信息，进行接口调用方、接口和接口版本的标准化定义，并进一步定义接口调用方、接口和接口版本三者的映射关系；
针对政务***提供的对外接口，设定统一入口和对外接口的通用处理流程；
基于接口调用方、接口和接口版本三者的映射关系，通过统一入口和对外接口的通用处理流程实现接口鉴权、接口权限管理和接口监控。
可选的，预先采集的接口调用方信息包含：调用方唯一标识apikey、调用方名称、接口内容是否加密、对称加密秘钥、是否限制调用IP、IP白名单及是否可用。
进一步可选的，定义的接口信息包括：接口唯一标识，接口名，接口文档内容，接口是否可用，当前接口最新版本号；
定义的接口版本信息包括：接口唯一标识，接口版本号，接口实际调用路径，版本功能描述，版本负责人手机号，是否可用，是否需要记录日志。
进一步可选的，接口版本定义信息中的“是否需要记录日志”字段决定接口调用时是否记录接口日志，接口日志记录信息包括：身份令牌token，接口唯一标识，接口版本号，接口入参，接口出参，异常日志，调用结果状态，接口耗时，调用时间，关联业务编号。
进一步可选的，定义的接口调用方、接口和接口版本三者的映射关系信息包括：调用方唯一标识apikey，接口唯一标识，接口版本号，是否可用，更新时间；
根据调用方唯一标识apikey即可查出该接口调用方使用到的所有接口，并导出其接口描述信息作为接口文档的参考依据。
进一步可选的，统一入口采用身份令牌token的方式实现接口鉴权，具体过程如下：
接口调用方先携带调用方唯一标识apikey、当前时间的时间戳、36位随机码及前述三者组合的字符串的SHA256算法摘要来获取政务***的身份令牌token，再携带该身份令牌token调用具体的功能接口；
在调用具体的功能接口时，政务***先验证身份令牌token，验证通过后根据接口调用方、接口、接口版本的映射关系来确认该接口调用方是否拥有该功能接口的调用权限，如有权限且该接口版本可用则正常调用接口并返回，如有该接口该版本的权限但版本不可用，则提示联系***管理员进行新版本接口授权。
进一步可选的，统一入口按照对外接口的通用处理流程实现接口权限管理，具体过程如下：
统一入口调用处理政务***的所有对外接口，
在调用政务***的对外接口为身份令牌token获取接口时，进行IP白名单校验及鉴权校验，校验均通过后返回身份令牌token并记录鉴权日志；
在调用政务***的对外接口为具体的功能接口时，对接口中的身份令牌token进行验证，验证通过后，确定该接口调用方的接口唯一标识，接口版本号，明确具体的功能调用接口，再根据接口调用方的定义信息确认是否要对参数进行解密处理，最后调用具体功能接口返回接口调用结果并且记录接口调用日志信息。
进一步可选的，通过统一入口实现接口监控，具体内容包括：
根据接口唯一标识和接口版本号间隔设定时间做一次统计，如果调用失败次数超过设定次数，则以短信的形式通知该接口版本的负责人；
以列表的形式展示接口耗时情况，***研发或运维人员根据列表展示内容进行相应接口的优化。
本发明的一种政务***对外接口的标准化管理方法，与现有技术相比具有的有益效果是：
(1)本发明将政务***对外接口进行统一的管理，可以解决对外接口开发过程中接口开发规范和流程缺乏一致性、对外接口开发维护、问题排查困难等实际问题；
(2)本发明基于接口调用方、接口、接口版本及三者之间的映射关系，可以规范***研发和运维人员接口对接流程，简化接口的使用与维护，并降低接口问题排查的难度，提升***接口的稳定性、多版本兼容性；通过统一入口实现接口监控过程中，基于接口日志记录信息，还能让***研发和运维人员及时了解接口异常的情况并方便的进行问题排查，同时也能提供看板，让研发和运维人员了解到接口耗时统计情况，以便对接口性能进行优化，提升接口性能。
附图说明
附图1是本发明实施例一实现接口鉴权的流程图；
附图2是本发明实施例一实现接口权限管理的流程图。
具体实施方式
为使本发明的技术方案、解决的技术问题和技术效果更加清楚明白，以下结合具体实施例，对本发明的技术方案进行清楚、完整的描述。
实施例一：
本实施例提出一种政务***对外接口的标准化管理方法，其包括如下步骤：
(一)预先采集政务***对外接口的接口调用方信息，包含：调用方唯一标识apikey、调用方名称、接口内容是否加密、对称加密秘钥、是否限制调用IP、IP白名单及是否可用；
基于采集的接口调用方信息、以及政务***对外接口，进行接口调用方、接口和接口版本的标准化定义，并进一步定义接口调用方、接口和接口版本三者的映射关系。
定义的接口信息包括：接口唯一标识，接口名，接口文档内容，接口是否可用，当前接口最新版本号。
定义的接口版本信息包括：接口唯一标识，接口版本号，接口实际调用路径，版本功能描述，版本负责人手机号，是否可用，是否需要记录日志。接口版本定义信息中的“是否需要记录日志”字段决定接口调用时是否记录接口日志，接口日志记录信息包括：身份令牌token，接口唯一标识，接口版本号，接口入参，接口出参，异常日志，调用结果状态，接口耗时，调用时间，关联业务编号。当研发人员或者运维人员需要排查接口相关问题时，可使用接口调用方提供的接口信息来查询对应的接口调用日志作为排查问题的依据。
定义的接口调用方、接口和接口版本三者的映射关系信息包括：调用方唯一标识apikey，接口唯一标识，接口版本号，是否可用，更新时间。根据调用方唯一标识apikey即可查出该接口调用方使用到的所有接口，并导出其接口描述信息作为接口文档的参考依据。
(二)针对政务***提供的对外接口，设定统一入口和对外接口的通用处理流程。
(三)基于接口调用方、接口和接口版本三者的映射关系，通过统一入口和对外接口的通用处理流程实现接口鉴权、接口权限管理和接口监控。
(i)结合附图2，统一入口采用身份令牌token的方式实现接口鉴权，具体过程如下：
接口调用方先携带调用方唯一标识apikey、当前时间的时间戳、36位随机码及前述三者组合的字符串的SHA256算法摘要来获取政务***的身份令牌token，再携带该身份令牌token调用具体的功能接口；
在调用具体的功能接口时，政务***先验证身份令牌token，验证通过后根据接口调用方、接口、接口版本的映射关系来确认该接口调用方是否拥有该功能接口的调用权限，如有权限且该接口版本可用则正常调用接口并返回，如有该接口该版本的权限但版本不可用，则提示联系***管理员进行新版本接口授权。
(ii)结合附图2，统一入口按照对外接口的通用处理流程实现接口权限管理，具体过程如下：
统一入口调用处理政务***的所有对外接口，
在调用政务***的对外接口为身份令牌token获取接口时，进行IP白名单校验及鉴权校验，校验均通过后返回身份令牌token并记录鉴权日志；
在调用政务***的对外接口为具体的功能接口时，对接口中的身份令牌token进行验证，验证通过后，确定该接口调用方的接口唯一标识，接口版本号，明确具体的功能调用接口，再根据接口调用方的定义信息确认是否要对参数进行解密处理，最后调用具体功能接口返回接口调用结果并且记录接口调用日志信息。
(iii)通过统一入口实现接口监控，具体内容包括：
根据接口唯一标识和接口版本号间隔设定时间做一次统计，如果调用失败次数超过设定次数，则以短信的形式通知该接口版本的负责人；
以列表的形式展示接口耗时情况，***研发或运维人员根据列表展示内容进行相应接口的优化。
综上可知，采用本发明的一种政务***对外接口的标准化管理方法，将政务***对外接口进行统一的管理，可以解决对外接口开发过程中接口开发规范和流程缺乏一致性、对外接口开发维护、问题排查困难等实际问题。
以上应用具体个例对本发明的原理及实施方式进行了详细阐述，这些实施例只是用于帮助理解本发明的核心技术内容。基于本发明的上述具体实施例，本技术领域的技术人员在不脱离本发明原理的前提下，对本发明所作出的任何改进和修饰，皆应落入本发明的专利保护范围。
Claims (8)
1.一种政务***对外接口的标准化管理方法，其特征在于，包括如下步骤：
预先采集政务***对外接口的接口调用方信息，进行接口调用方、接口和接口版本的标准化定义，并进一步定义接口调用方、接口和接口版本三者的映射关系；
针对政务***提供的对外接口，设定统一入口和对外接口的通用处理流程；
基于接口调用方、接口和接口版本三者的映射关系，通过统一入口和对外接口的通用处理流程实现接口鉴权、接口权限管理和接口监控。
2.根据权利要求1所述的一种政务***对外接口的标准化管理方法，其特征在于，预先采集的接口调用方信息包含：调用方唯一标识apikey、调用方名称、接口内容是否加密、对称加密秘钥、是否限制调用IP、IP白名单及是否可用。
3.根据权利要求2所述的一种政务***对外接口的标准化管理方法，其特征在于，定义的接口信息包括：接口唯一标识，接口名，接口文档内容，接口是否可用，当前接口最新版本号；
定义的接口版本信息包括：接口唯一标识，接口版本号，接口实际调用路径，版本功能描述，版本负责人手机号，是否可用，是否需要记录日志。
4.根据权利要求3所述的一种政务***对外接口的标准化管理方法，其特征在于，接口版本定义信息中的“是否需要记录日志”字段决定接口调用时是否记录接口日志，接口日志记录信息包括：身份令牌token，接口唯一标识，接口版本号，接口入参，接口出参，异常日志，调用结果状态，接口耗时，调用时间，关联业务编号。
5.根据权利要求3所述的一种政务***对外接口的标准化管理方法，其特征在于，定义的接口调用方、接口和接口版本三者的映射关系信息包括：调用方唯一标识apikey，接口唯一标识，接口版本号，是否可用，更新时间；
根据调用方唯一标识apikey即可查出该接口调用方使用到的所有接口，并导出其接口描述信息作为接口文档的参考依据。
6.根据权利要求5所述的一种政务***对外接口的标准化管理方法，其特征在于，统一入口采用身份令牌token的方式实现接口鉴权，具体过程如下：
接口调用方先携带调用方唯一标识apikey、当前时间的时间戳、36位随机码及前述三者组合的字符串的SHA256算法摘要来获取政务***的身份令牌token，再携带该身份令牌token调用具体的功能接口；
在调用具体的功能接口时，政务***先验证身份令牌token，验证通过后根据接口调用方、接口、接口版本的映射关系来确认该接口调用方是否拥有该功能接口的调用权限，如有权限且该接口版本可用则正常调用接口并返回，如有该接口该版本的权限但版本不可用，则提示联系***管理员进行新版本接口授权。
7.根据权利要求6所述的一种政务***对外接口的标准化管理方法，其特征在于，统一入口按照对外接口的通用处理流程实现接口权限管理，具体过程如下：
统一入口调用处理政务***的所有对外接口，
在调用政务***的对外接口为身份令牌token获取接口时，进行IP白名单校验及鉴权校验，校验均通过后返回身份令牌token并记录鉴权日志；
在调用政务***的对外接口为具体的功能接口时，对接口中的身份令牌token进行验证，验证通过后，确定该接口调用方的接口唯一标识，接口版本号，明确具体的功能调用接口，再根据接口调用方的定义信息确认是否要对参数进行解密处理，最后调用具体功能接口返回接口调用结果并且记录接口调用日志信息。
8.根据权利要求7所述的一种政务***对外接口的标准化管理方法，其特征在于，通过统一入口实现接口监控，具体内容包括：
根据接口唯一标识和接口版本号间隔设定时间做一次统计，如果调用失败次数超过设定次数，则以短信的形式通知该接口版本的负责人；
以列表的形式展示接口耗时情况，***研发或运维人员根据列表展示内容进行相应接口的优化。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202311435413.8A CN117492951A (zh) | 2023-11-01 | 2023-11-01 | 一种政务***对外接口的标准化管理方法 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202311435413.8A CN117492951A (zh) | 2023-11-01 | 2023-11-01 | 一种政务***对外接口的标准化管理方法 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN117492951A true CN117492951A (zh) | 2024-02-02 |
Family
ID=89666873
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202311435413.8A Pending CN117492951A (zh) | 2023-11-01 | 2023-11-01 | 一种政务***对外接口的标准化管理方法 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN117492951A (zh) |
-
2023
- 2023-11-01 CN CN202311435413.8A patent/CN117492951A/zh active Pending
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| US20180018738A1 (en) | Digital asset platform | |
| CN104217288A (zh) | 社区综合网格安全管理装置和*** | |
| CN110995661B (zh) | 一种网证平台 | |
| CN116167085A (zh) | 一种数据脱敏方法和装置 | |
| CN110192212B (zh) | 数字资产平台 | |
| CN112445870A (zh) | 基于手机取证电子数据的知识图谱串并案分析方法 | |
| CN110970120B (zh) | 基于区块链的家庭医生管理***及方法 | |
| CN107181753A (zh) | 移动终端财务***及方法 | |
| CN213122985U (zh) | 一种pis认证*** | |
| CN111506661B (zh) | 一种内容访问管理方法、装置和存储介质 | |
| CN109885555B (zh) | 一种用户信息管理方法及装置 | |
| CN111881479A (zh) | 一种基于区块链的反洗钱名单共享***和方法 | |
| CN113496002A (zh) | 一种基于移动中台的移动应用平台 | |
| CN117492951A (zh) | 一种政务***对外接口的标准化管理方法 | |
| CN113360575B (zh) | 联盟链中交易数据的监管方法、装置、设备及存储介质 | |
| CN112966049B (zh) | 一种基于区块链的资产管理*** | |
| CN115134378A (zh) | 一种区块链智慧医疗*** | |
| CN114240349A (zh) | 一种基于区块链的生态环境监管方法及其*** | |
| CN113642975A (zh) | 基于区块链的氢能监管方法和*** | |
| CN113487280A (zh) | 一种基于云平台的会议管理*** | |
| CN112100589A (zh) | Kyc数字身份管理*** | |
| CN113421052A (zh) | 数据共享管理方法、***、及计算机可读存储介质 | |
| JP5062134B2 (ja) | 情報拡散システム、情報拡散装置、情報拡散方法、および情報拡散プログラム | |
| CN110933064A (zh) | 确定用户行为轨迹的方法及其*** | |
| CN112448972A (zh) | 数据交换与共享平台 |
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 |