Dr3@m's Blog
·
海滨校园助手api使用文档
内容提要
海滨校园助手API提供公共和专用接口。公共接口通过授权秘钥获取用户信息，返回成功或失败状态；专用接口面向学校可信组织，允许通过学号、姓名等信息获取相关数据。接口调用方式和返回数据格式已详细说明。
关键要点
-
公共接口面向所有组织及个人开放，开发者可以凭借用户授权秘钥确认用户身份，获取用户姓名、班级等信息。
-
公共接口调用链接为：https://hbscher.dr34m.cn/pubapi?safekey=xxxxx，授权秘钥只能使用一次，用完即失效。
-
返回数据样式包括成功和失败的状态，成功时返回用户的唯一身份码、学号、姓名、年级、学院、专业和班级等信息，失败时返回秘钥错误信息。
-
专用接口仅面向学校可信组织开放，开发者可以凭借学号、姓名、专业、班级等信息获取相关信息。
-
专用接口调用链接格式为：url?token=专用秘钥&keytype=索引类型&keyword=索引数据，索引类型包括班级、专业、学号和姓名。
-
返回数据样式可以是单个用户信息或多个用户信息，均包含用户的唯一身份码、学号、姓名、年级、学院、专业和班级等信息。
延伸问答
海滨校园助手API的公共接口有什么功能？
公共接口允许开发者通过用户授权秘钥获取用户的姓名、班级等信息，并返回成功或失败状态。
如何调用海滨校园助手API的公共接口？
调用公共接口的链接为：https://hbscher.dr34m.cn/pubapi?safekey=xxxxx，需将xxxxx替换为对应的授权秘钥。
专用接口与公共接口有什么区别？
专用接口仅面向学校可信组织开放，允许通过学号、姓名等信息获取相关数据，而公共接口面向所有组织及个人开放。
如果调用海滨校园助手API失败，返回的数据格式是什么？
失败时返回的数据格式包括一个错误代码和错误信息，例如：{ 'data': null, 'code': 500, 'msg': '秘钥错误' }。
如何获取海滨校园助手API的专用接口资格？
申请专用接口资格请联系ctftools@qq.com，获取相关的url和专用秘钥。
海滨校园助手API的返回数据包含哪些信息？
返回数据包含用户的唯一身份码、学号、姓名、年级、学院、专业和班级等信息。
