通达OA系统对接

1 概述

1.1 目的

本文档主要描述《高校统一数据开放平台》管理系统的使用说明。主要内容包括概述和使用说明两个方面，适用产品使用者、测试人员、系统维护人员以及相关评审专家等，下面将展开相关说明。

1.2 读者对象

本文档适用产品使用者、测试人员、系统维护人员以及相关评审专家等。未经产品经理许可，该文档不得提供给规定对象以外的人员阅读或使用。

2 使用说明

开发者是平台应用的开发者，开发者可以新增或查看自己在平台上添加的应用；同时，平台用户也可以访问数据集市，浏览数据集市中的数据，根据自己的需要申请调用数据，支持API接口、直连数据库和计算数据集等多种方式，管理员审批通过后，开发者可以调用数据。

2.1 开发者中心

开发者登录平台后默认进入到开发者中心的页面，开发者可以在开发者中心创建应用、为应用申请数据以及查看已创建的应用数据调用情况，开发者中心提供了多种使用文档，可帮助开发者快速了解并使用平台申请、调用数据。

2.1.1 应用管理

应用管理汇总展示了开发者自己在平台中新建的应用，该页面可根据应用状态（全部/已上架/未上架/已下架）或在右上角检索栏输入应用名称进行快速筛选。如图2-1-1。

图2-1-1

点击右上角的创建新应用可跳转到新增应用的页面，带“*”号的内容为必填项，信息填写完毕后点击保存按钮，保存成功即应用创建成功。新建的应用默认状态为未上架，运行情况为开发中。如图2-1-2。

图2-1-2

在应用管理页面点击右上角的开发者操作指南可打开开发者快捷指南，快捷指南中包含了开发者常用操作的操作说明。如图2-1-3。

图2-1-3

在应用管理页面操作栏中点击预览，可跳转到应用地址页面，预览该应用。

在应用管理页面操作栏中点击查看按钮可查看该应用的具体信息，在该页面可以申请应用上架、编辑/修改应用的基本信息、管理API、数据开放、数据计算等操作。如图2-1-4。

图2-1-4

在应用查看页面点击右上角的申请上架，将跳转到应用申请上架的页面，填写表单信息后保存，该申请会推送给后台管理员进行审核，审核通过后，该应用的状态将变为已上架。如图2-1-5。

图2-1-5

如应用已经上架，点击应用查看进入应用详情页，右上角的申请上架按钮将展示为申请下架按钮。如图2-1-6。

图2-1-6

除下架功能外，已上线的应用支持通过开启维护按钮进入维护期，应用进入维护期后，平台用户在前台应用大厅预览该应用时会进入已设定好的维护页面。如图2-1-7。注：该功能主要用于学校应用升级或处于某种特殊时期时，应用无法访问又不想下架或隐藏应用时使用，应用进入维护期后，开启维护按钮将变为结束维护按钮，开发者可自行结束应用维护阶段。

图2-1-7

在应用管理页面操作栏中点击删除按钮，再次确认之后该应用将从应用列表中移除。如图2-1-8。注：运行中/维护中的应用操作区域的删除按钮为灰色，无法删除，需要先申请下架之后才可以删除。

图2-1-8

（一）管理基本信息

在查看应用详情页（见图2-1-4），开发者可以点击基本信息区域的管理基本信息按钮对应用详情进行编辑。如图2-1-9。注：如该应用已经上线，修改应用基本信息之后会向后台提交一条应用变更申请，管理员可对该申请进行审核，审核同意后该修改生效。

图2-1-9

已上架的应用在基本信息区域会存在一个查看上架信息的按钮，点击查看上架信息可以查看应用的上架信息。如图2-1-10。注：未上架的应用没有该按钮。

图2-1-10

在查看应用详情页点击基本信息区域的“APP Key”按钮可以查看该应用唯一对应的App Key和App Secret，点击复制按钮可快速将对应内容复制到剪切板。图2-1-11。

图2-1-11

（二） API管理

在查看应用详情页（图2-1-4），通过API管理区域的“申请API”按钮可跳转到申请API的页面，页面左侧支持根据API分类进行筛选，API分类后的括号中展示的内容是指：分类下有数据的API数量/分类下API总数量；页面右侧展示了该API分类中的API