帮助文档式网站模板-#能力开放平台产品功能手册

能力开放平台产品功能手册产品背景

信息化校园建设逐步从网络基础设施建设和一些孤立应用系统的完善转向建设全球一体化的信息系统,解决了校园建设带来的信息安全、信息孤岛和管理职责不清等威胁。业务系统。 困境。 随着高校IT应用的快速发展,应用能力的重复建设以及应用之间的大量交互,导致系统网络变得越来越复杂,单一应用系统变得越来越庞大,系统维护和后续版本迭代变得越来越复杂。 更复杂。

产品介绍

金智教育信息有限公司基于多年对校园信息服务总线的研究和实践,成功研发了轻量级校园信息服务总线——能力开放平台(ESOP)。 信息化建设中碎片化服务的注册、申请、监控、认证、路由、转发全方位管理的服务框架

产品系统架构

产品特性平台特性平台独立性

能力开放平台ESOP完全基于J2EE技术​​开发,具有平台无关的特点。

标准化

只要满足国际标准化的SOAP和RESTFUL套接字契约的套接字可以注册到ESOP平台,ESOP平台就可以统一进行授权、监控、路由和转发

使用方便

提供友好易用的界面帮助文档式网站模板,更符合高校用户的操作习惯。为用户登录提供统一身份认证和第三方注册两种模式,方便教师、学生和第三方当事人用户登录系统

全面的套接字操作监控

提供管理员查看所有socket的调用统计,监控所有请求的IP地址、请求参数、响应参数等详细信息,并可以对API socket进行全方位监控。

快速应用部署

对于金智提供的应用程序,不再需要关心应用程序是否调用底层的API套接字,而只需要关注应用程序本身是否已经连接到中学完成部署和使用该应用程序。

开放性

ESOP能力开放平台支持中学生、教师、第三方厂商将符合SOAP和RESTFUL规范的socket注册到平台中,平台可以对其进行统一授权和监控,实现所有系统的集成学校整体运行平台不断丰富应用和实践。

特征

产品提供统一的API入口展示,统一展示系统中开放的所有API,方便所有用户及时查询对应的API方法参数

产品提供统一的文档功能,方便教师、学生、第三方厂商快速开发和使用API

产品提供统一身份认证和第三方邮箱注册两种认证方式,并支持管理员设置相应的用户权限,实现对用户权限的精细控制

产品为开发者提供注册API和申请使用API​​的功能,方便教师、学生、第三方厂商快速注册和申请使用API

产品为管理员提供对已注册API及申请使用的API的初审操作

产品提供管理员监控每个应用调用API的详细数据,并显示相应的统计列表

管理员可以维护系统中使用的分类、标签、模板、文档和学校信息

产品提供统一网段功能,实现动态路由、断路器隔离、负载均衡、详细的socket调用日志、接口调用统计分析等相关功能

与上一代产品对比 产品核心框架

基于开源成熟框架SpringBoot和SpringCloud开发,放弃了原来对OSB、Redis、Nginx、Lua等第三方厚平台和框架的强烈依赖,采用纯java实现。

客运中心模块

功能主要包括以下几个:

在线文档 套接字文档

所有socket都支持按类别显示和按关键字查询,并且可以查看每个socket定义的详细信息,包括方法名称、请求参数和响应参数格式。

帮助文档

在系统中,您可以查看如何快速开发socket、申请使用socket、注册socket的相关规范文档,指导开发者基于能力开放平台提供的能力快速开发应用。

开发者管理

系统支持基于统一身份认证IDS的用户登录,以及门户网站第三方注册登录。 系统帐户具有三种角色:

超级管理员

丰富开发者和普通管理员的所有角色功能

普通开发者可以设置为管理员,也可以撤销管理员角色

总管理员

对开放者注册或申请的API进行初审

对提供的 API 执行服务器绑定操作

普通开发者可设置免试初审权限

开发商

开发的API可以在ESOP系统中注册,并可以在当前ESOP系统中申请和使用。

网段功能

支持路由动态负载、断路隔离、负载均衡策略帮助文档式网站模板,可实现socket调用实时监控,包括监控调用IP、请求延迟、响应码率、分配路由地址,并可视化统计显示socket调用频率

部署

只需要在操作系统中安装JDK1.7以上版本,ESOP就可以正常使用。 ESOP支持Oracle和MySql数据库

产品功能介绍 乘客模块API中心

可以在线查看当前系统支持的API列表。可以按照分类过滤或者支持通过关键词搜索对应的API列表,同时开发者还可以查看API的详细信息

查看特定API的详细定义信息

帮助文档

该模块为开发者提供了开发socket、申请socket的规范文档,同时指导开发者如何使用ESOP平台、平台相关法律条款等相关内容

用户中心

ESOP系统支持统一身份认证登录和邮箱注册账号形式的第三方登录。 用户首次登录时,角色为普通开发者角色,开发者可以被系统超级管理员设置为管理员角色。

开发者注册

第三方公司的开发者可以使用电子邮件账户注册ESOP。 注册后,开发者将收到一封需要激活的电子邮件。 开发者点击激活邮件后,账户激活成功

激活邮件如下:

用户登录

ESOP系统支持两种形式的用户登录

学工帐号登录

为什么有统一身份认证系统IDS,但是在统一身份认证中设置了相应的ESOP访问权限后,开发者可以使用学号登录

使用电子邮件登录

如果您是第三方公司的开发者,可以使用邮箱账号直接登录ESOP系统

用户角色

ESOP系统中的用户分为开发者、管理员、超级管理员三种角色

超级管理员

丰富开发者和普通管理员的所有角色功能

普通开发者可以设置为管理员,也可以撤销管理员角色

行政人员

对开放者注册或申请的API进行初审

对提供的 API 执行服务器绑定操作

普通开发者可设置免试初审权限

开发商

开发的API可以注册到ESOP系统

文档模板式网站帮助下载_帮助文档式网站模板_文件模板网站

您可以申请使用当前ESOP系统中已存在的API套接字

开发者中心

开发者登录系统后,可以创建API并在开发者中心申请使用该API

发布API

开发者可以将自己开发的API套接字注册到系统中,同时查看所有已经注册的API列表

查看已注册的API列表

发布API,填写API名称,选择类别、所属应用,部署URI地址即可发布API套接字

申请使用API

如果开发者在开发应用程序时需要使用API​​ Socket,可以在ESOP系统中申请。操作步骤是先创建一个应用程序,然后在该应用程序中申请所需的API Socket

新应用:

选择所需的API套接字

管理中心

管理员可以对开放者注册的API和申请使用的API进行初步审核和关闭,使对应的socket能够正常使用

注册API管理注册API的初审

管理员可以对开发者注册的socket进行初审,只有通过初审的接口才允许其他应用程序使用

服务器管理

套接字只能在特定的服务器上正常运行。 为此,服务器管理就是维护一个当前校园内所有服务器的列表

服务器绑定服务

提供API套接字的应用程序需要与服务器关联才能访问ESOP网段系统中对应的套接字

使用 API 进行管理

管理员可以管理开发者申请使用API​​的信息,包括以下功能:

申请API初审

管理员可以对开发者申请的API进行初步审核。 初审通过后,系统会给应用程序分配一个token,作为后续socket调用的授权码。

待初步审查名单

初步审核名单

统计分析

管理员可以按应用查看系统中各个socket的调用状态,可汇总调用总数、成功和失败次数,并根据每个应用进行单独统计,并查看某个socket调用的请求IP,通话时长及其他相关信息

应用信息维护

为了避免后续应用升级后难以申请新的socket但对应开发者调整的问题,管理员可以降低应用级别,其他开发者可以维护该应用

开发者管理

管理员可以对系统中的开发者进行管理,并可以设置开发者的免预审权限。 同时,如果是校外用户(使用邮箱账号登录的用户),管理员可以删除

系统配置管理

在实际操作过程中,系统需要配置分类、标签、文档、系统邮件模板调整、学校信息查看等相关功能。

系统分类管理

API中心可以根据类别展示对应的API列表。 如果中学想要减少类别,可以由管理员在系统类别管理中维护

系统标签管理

API中还有一个属性叫label,用于标记API的一个子类。 支持关键字搜索,管理员可维护标签

邮件模板管理

但用户完成注册、忘记密码时系统需要发送邮件,支持五级安全的动态验证码。 由于每个中学的邮件主题和正文内容可能有所不同,因此支持中学进行调整。

文件管理

乘客可以在帮助文档中看到系统约定、开发指南、系统操作手册。 每个中学的这个内容都不同,所以支持中学管理员手动添加相应的文档内容

文档模板式网站帮助下载_文件模板网站_帮助文档式网站模板

二次信息管理

系统中需要查看当前系统版本号、网段地址、升级时间等相关信息,并支持同时更改,并手动将学校终端产生的数据同步到云端

服务部分

支持路由动态负载、断路隔离、负载均衡策略,可实现socket调用实时监控,包括监控调用IP、请求码率、响应码率、分配路由地址,并可视化统计显示socket使用频率来电

支持复制详细消息日志,跟踪应用APP调用API套接字的消息流向,方便消息跟踪和问题定位

运行环境能力 Open Portal 环境要求

能力开放门户的环境要求如下:

内容描述

数据库支持

MYSQL5.7、Oracle11g、Oracle12c

JAVA环境

JDK1.7以上版本

视频内存

2G以上

硬盘

40G以上

服务网段环境要求

业务网段环境要求如下:

内容描述

数据库支持

MYSQL5.7、Oracle11g、Oracle12c

JAVA环境

JDK1.7以上版本

视频内存

2G以上

硬盘

40G以上