基本概念

微校具有相对强势的市场品牌号召力,平台做为中心的信息资源管理者,提供信息数据接口,使第三方也能借用微校平台进行开发创作为各大高校进行更优质的服务,同时,小程序和H5“低门槛”的开发难度也更加方便开发者参与到微校这个平台中来,共同完善微校平台强大的生态圈。

应用操作

应用操作模块是关于应用的一些接口及如何进行相关操作的说明,例如开启应用,关闭应用,应用监控等接口以及如何进行应用跳转,管理应用后台,和统计应用。

身份验证

身份验证模块是分移动端获取用户身份,以及PC端获取管理员身份的详细说明。移动端获取用户身份又分为两种:移动端H5获取用户身份,移动端小程序获取用户身份。

校园码身份验证

校园码身份验证模块分为两个部分,一个是校园码解码接口的说明,另一个是对如何进行校园码事件回调,回调码以及回调示例的一些展示。

主体信息管理

主体信息管理模块是需要拿到应用有效凭证,然后根据有效凭证再去相关接口获取自己所需的信息。提供的接口有:获取主体基本信息,获取组织架构,获取单个组织架构成员,获取多个组织架构成员,搜索成员。

消息通知

消息通知模块主要是一些关于消息通知的接口说明,例如查询通知能力,发送通知,通知数据明细,用户阅读通知情况。

校园卡

校园卡模块主要是一些小程序与校园卡之间一些操作的接口说明,例如小程序打开校园卡,小程序添加校园卡,校园卡进入小程序。

相关工具

相关工具模块主要是一些方便开发的工具类,应用的demo,加解密的demo,还有接口签名用到的签名算法。还有两个验证工具,签名验证工具和接口验证工具。

全局变量说明

1,本文档使用的应用启用地址:

https://www.example.com/index

2,应用接口类型说明:

为了便于管理,收拢应用接口地址。

应用接口类型地址 用途
https://www.example.com/index?type=open 开启应用
https://www.example.com/index?type=close 关闭应用
https://www.example.com/index?type=trigger H5应用跳转
https://www.example.com/index?type=manage 应用管理后台
https://www.example.com/index?type=monitor 应用监控

3,学校信息接口说明:

获取管理员信息:为统一微校平台和应用管理后台的用户体系,该接口可供微校平台管理员信息获取

获取学校信息:只有学校对应用处于开启状态时,接口才允许调用

4,本文档使用的AppKey和AppSecret如下:

AppKey: BE30B2BA30ABFADB

AppSecret: CF8CDD8D0B7B1ACDA76201F406BED81E

实际AppKey(16位)和AppSecret(32位)由微校提供。