Skip to content
Permalink
Browse files

更新

  • Loading branch information...
TLingC committed May 5, 2019
1 parent d81b258 commit 7b9a5c4d42ec55ab5d9603afd52835e368343761
@@ -2,10 +2,13 @@
强智教务系统API文档 强智教务系统API文档


## 介绍 ## 介绍
这是一个通过对强智教务系统提供的智校园APP抓包得出的API文档。在原有的[TLingC/QZAPI_Archive](https://github.com/TLingC/QZAPI_Archive)项目的基础上,加入了如参数、返回值、例程等信息,有效提高开发者的文档阅读体验及开发效率。 这是一个通过对强智教务系统官方提供的智校园APP抓包得出的API文档。在原有的[TLingC/QZAPI_Archive](https://github.com/TLingC/QZAPI_Archive)项目的基础上,加入了如参数、返回值、例程等信息,有效提高开发者的文档阅读体验及开发效率。


目前,文档尚未编写完毕,并非所有的接口文档都已编写完毕。 此API支持查询课程表、成绩、考试信息、空教室等绝大部分会被高频使用到的信息,相比通过抓取页面获取信息效率更高,但是无法实现如抢课之类的高级功能。
你可以先参阅此前的项目[TLingC/QZAPI_Archive](https://github.com/TLingC/QZAPI_Archive),同时也欢迎Fork本项目,帮助我们完善文档。


## 文档查看 由于条件所限,部分如学籍预警、考试信息接口的API参数或返回值尚未明晰,欢迎Fork本项目进行补充。
你可以通过以下地址访问文档的网页版:https://qzapi.github.tlingc.com
## 查看
你可以通过以下地址访问文档的网页版:[https://qzapi.github.tlingc.com](https://qzapi.github.tlingc.com),相比在Github上直接查看源文件更加友好。

亦可通过下载 [gh-pages](https://github.com/TLingC/QZAPI/tree/gh-pages) 分支离线查看文档。
@@ -3,16 +3,18 @@


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=authUser&xh={$学号}&pwd={$密码}
``` ```
##请求参数
##参数
```js ```js
request.data{ request.data{
"method":'authUser', //必填 "method":'authUser', //必填
"xh":'登陆教务系统使用的学号', //必填 "xh":'登陆教务系统使用的学号', //必填
"pwd":'登陆教务系统需要的密码' //必填 "pwd":'登陆教务系统需要的密码' //必填
} }
``` ```

##返回 ##返回
``` json ``` json
{ {
@@ -27,6 +29,6 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=authUser&xh=17111111&pwd=1234578 GET http://jwxt.xxxx.edu.cn/app.do?method=authUser&xh=17111111&pwd=1234578
``` ```
@@ -3,16 +3,17 @@


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getCjcx&xh={$学号}&xnxqid={$学年学期ID}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getCjcx', //必填 'method':'getCjcx', //必填
'xh':'2017168xxxxx', //必填,可以添加非本token学号查询他人成绩 'xh':'2017168xxxxx', //必填,可以添加非本token学号查询他人成绩
'xqxnid':'2017-2018-2' //非必填,不填输出全部成绩 'xqxnid':'2017-2018-2' //非必填,不填输出全部成绩
} }
``` ```


##返回 ##返回
@@ -36,5 +37,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getCjcx&xh=201716xxxxx&xnxqid=2017-2018-2 GET http://jwxt.xxxx.edu.cn/app.do?method=getCjcx&xh=201716xxxxx&xnxqid=2017-2018-2
``` ```
@@ -3,15 +3,16 @@


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getCurrentTime&currDate={$查询日期}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getCurrentTime', //必填 'method':'getCurrentTime', //必填
'currDate': //格式为"YYYY-MM-DD",必填,留空调用成功,但返回值均为null 'currDate': //格式为"YYYY-MM-DD",必填,留空调用成功,但返回值均为null
} }
``` ```


##返回 ##返回
@@ -26,5 +27,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getCurrentTime&currDate=2019-01-14 GET http://jwxt.xxxx.edu.cn/app.do?method=getCurrentTime&currDate=2019-01-14
``` ```
@@ -1,19 +1,19 @@
#学籍预警信息 #学籍预警信息
获取学籍预警信息 获取学籍预警信息
注意:条件所限制,暂未明晰


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getEarlyWarnInfo&xh={$学号}&history={$是否查询历史记录}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getEarlyWarnInfo', //必填 'method':'getEarlyWarnInfo', //必填
'xh':'2017168xxxxx', //条件所限制,暂未明晰 'xh':'2017168xxxxx', //学号
'history':1 //条件所限,暂未明晰。1为历史预警,0为当前预警 'history':1 //1为历史预警,0为当前预警
} }
``` ```


##返回 ##返回
@@ -23,5 +23,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getEarlyWarnInfo&xh=201716xxxxx&history=1 GET http://jwxt.xxxx.edu.cn/app.do?method=getEarlyWarnInfo&xh=201716xxxxx&history=1
``` ```
@@ -1,17 +1,18 @@
#校区教学楼信息 #教学楼信息
获取校区教学楼信息 获取某个校区教学楼信息


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getJxlcx&xqid={$校区ID}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getJxlcx', //必填 'method':'getJxlcx', //必填
'xqid':'1' //非必填,默认值未知 'xqid':'1' //校区ID
} }
``` ```


##返回 ##返回
@@ -30,5 +31,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getJxlcx&xqid=1 GET http://jwxt.xxxx.edu.cn/app.do?method=getJxlcx&xqid=1
``` ```
@@ -1,19 +1,20 @@
#时间信息 #课程信息
获取当前时间、周次、学年等信息 获取一周的课程信息


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getKbcxAzc&xh={$学号}&xnxqid={$学年学期ID}&zc={$周次}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getKbcxAzc', //必填 'method':'getKbcxAzc', //必填
'xh':'2017168xxxxx', //必填,使用与获取token时不同的学号,则可以获取到新输入的学号的课表 'xh':'2017168xxxxx', //必填,使用与获取token时不同的学号,则可以获取到新输入的学号的课表
'xnxqid':'2018-2019-1', //格式为"YYYY-YYYY-X",非必填,不包含时返回当前日期所在学期课表 'xnxqid':'2018-2019-1', //格式为"YYYY-YYYY-X",非必填,不包含时返回当前日期所在学期课表
'zc':'1' //必填 'zc':'1' //必填
} }
``` ```


##返回 ##返回
@@ -43,5 +44,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getKbcxAzc&xh=101010000&xnxqid=2018-2019-1&zc=5 GET http://jwxt.xxxx.edu.cn/app.do?method=getKbcxAzc&xh=101010000&xnxqid=2018-2019-1&zc=5
``` ```
@@ -1,18 +1,18 @@
#考试信息 #考试信息
获取考试信息 获取考试信息
注意:条件所限制,暂未明晰


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getKscx&xh={$学号}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getKscx', //必填 'method':'getKscx', //必填
'xh':'2017168xxxxx', //条件所限制,暂未明晰 'xh':'2017168xxxxx', //学号
} }
``` ```


##返回 ##返回
@@ -22,5 +22,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getKscx&xh=201716xxxxx GET http://jwxt.xxxx.edu.cn/app.do?method=getKscx&xh=201716xxxxx
``` ```
@@ -1,21 +1,22 @@
#空教室信息 #空教室信息
获取空教室 获取空教室信息


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getKxJscx&time={$日期}&idleTime={$时间段}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getKxJscx', //必填 'method':'getKxJscx', //必填
'time':'2019-04-28', //格式"YYYY-MM-DD",非必填,默认返回当前日期空闲教室 'time':'2019-04-28', //格式"YYYY-MM-DD",非必填,默认返回当前日期空闲教室
'idleTime':'allday', //有allday,am,pm,night四种取值,非必填,默认值疑似allday 'idleTime':'allday', //有allday,am,pm,night四种取值,非必填,默认值疑似allday
'xqid':'1' , //校区ID,非必填 'xqid':'1' , //校区ID,非必填
'jxlid':'77', //教学楼ID,非必填 'jxlid':'77', //教学楼ID,非必填
'classroomNumber':'30' //可选项 30,30-40,40-50,60(分别意为30人以下,30-40人,···,60人以上) 'classroomNumber':'30' //可选项 30,30-40,40-50,60(分别意为30人以下,30-40人,···,60人以上)
} }
``` ```


##返回 ##返回
@@ -55,5 +56,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getKxJscx&time=2019-04-28&idleTime=allday GET http://jwxt.xxxx.edu.cn/app.do?method=getKxJscx&time=2019-04-28&idleTime=allday
``` ```
@@ -4,15 +4,16 @@


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getStudentIdInfo&xh={$学号}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getStudentIdInfo', //必填 'method':'getStudentIdInfo', //必填
'xh':'2017168xxxxx' //疑似非必填,添加或不添加本参数返回相同值 'xh':'2017168xxxxx' //疑似非必填,添加或不添加本参数返回相同值
} }
``` ```


##返回 ##返回
@@ -24,5 +25,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getStudentIdInfo&xh=101010000 GET http://jwxt.xxxx.edu.cn/app.do?method=getStudentIdInfo&xh=101010000
``` ```
@@ -3,15 +3,16 @@


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getUserInfo&xh={$学号}
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getUserInfo', //必填 'method':'getUserInfo', //必填
'xh':'201713984' //学号,必填,可以填写非本token学号获取其他人信息 'xh':'201713984' //学号,必填,可以填写非本token学号获取其他人信息
} }
``` ```


##返回 ##返回
@@ -38,5 +39,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getUserInfo&xh=201713984 GET http://jwxt.xxxx.edu.cn/app.do?method=getUserInfo&xh=201713984
``` ```
@@ -3,15 +3,16 @@


##请求 ##请求
``` url ``` url
GET http://教务系统URL/app.do? GET http://jwxt.xxxx.edu.cn/app.do?method=getXnxq
``` ```
##请求参数
##参数
```js ```js
request.header{token:'运行身份验证authUser时获取到的token,有过期机制'}, request.header{token:'运行身份验证authUser时获取到的token,有过期机制'},
request.data{ request.data{
'method':'getXnxq' , //必填 'method':'getXnxq' , //必填
'xh':'2017xxxxxx' //非必填 'xh':'2017xxxxxx' //非必填
} }
``` ```


##返回 ##返回
@@ -32,5 +33,5 @@ request.data{


##例程 ##例程
``` url ``` url
GET http://教务系统URL/app.do?method=getXnxq GET http://jwxt.xxxx.edu.cn/app.do?method=getXnxq
``` ```

0 comments on commit 7b9a5c4

Please sign in to comment.
You can’t perform that action at this time.