BIT101 API总览

接口实现

BIT101-GO链接

接口统一说明

接口整体采用了RESTful API的设计思想，主打一个简洁，易于调用和开发。

需要权限验证的接口需要在header中设置一个fake-cookie，该fake-cookie的获取方式请参考“用户模块”下相关接口的说明。

所有接口都以json格式返回，都可能带有一个msg字段，说明服务器的返回的提示信息，可以直接在前端显示给用户。

对于返回的状态码，一般有如下几个：

• 200：请求成功
• 400：请求参数错误
• 401：没有登录或没有权限
• 500：其他错误

学校教务说明

“学校教务”目录下的接口是学校服务器的，部分功能的底层实现依赖这些接口，这些接口并不由BIT101提供服务。

每个接口都提供了原生版本和webvpn版本两种链接，链接的转换使用了spencerwooo学长制作的工具网站。原生版本的部分接口需要在校园网内才能访问，并且需要自己管理各个站点的Cookie。而通过webvpn版链接访问时，只需要使用一个统一的Cookie与webvpn系统交互，webvpn系统会在其内部转发请求并自动处理好Cookie等。另外，在校园网内默认DNS会阻断webvpn网址的解析，如果想要在校园网内调用webvpn链接则需要手动设置DNS解析服务器。