接口说明
平台接口目前的开放范围,以及需要对接时该走什么流程。
先说结论:平台目前没有面向第三方开放的公共 API。
这不是能力问题,是范围问题。写这一页是为了让你不用去猜——如果你在评估对接方案,下面的信息应该够你做判断。
现状
服务端接口是给平台自己的客户端用的:运营后台和小程序。它们分成两类,安全模型完全不同。
管理类接口要求后台账号登录,并逐条校验权限。同一个接口,不同角色调用会得到不同结果,越权直接返回 FORBIDDEN。这类接口不对外。
客户端接口服务小程序和手机网页,要求微信授权后的会话凭证。它们只返回当前用户自己的数据,而且服务端会主动裁剪敏感字段——不是靠界面隐藏,是数据根本不下发。
两类接口都没有面向外部系统的凭证发放机制。也就是说,即使你拿到了接口地址,也没有合法的方式获得调用凭证。
接口参考文档
系统内置了一份 OpenAPI 规格和交互式参考页,覆盖全部接口的路径、参数和返回结构。
它在生产环境默认关闭。 这是有意的:接口清单本身也是信息,在没有对外开放计划之前不需要暴露。私有化部署或联调环境可以由运维打开。
如果你需要对接
请联系平台工作人员,说明这几件事:
- 要读还是要写。 只读的数据同步和需要回写的业务集成,方案完全不同。
- 涉及哪些数据。 学校这类公开主数据,和用户成绩这类个人信息,走的审批路径不一样。
- 调用方是谁。 是你们自己的服务端,还是要在浏览器或小程序里直接调用——后者对凭证方案有额外约束。
带着这三条来谈,通常一次就能确定可行性。反过来,如果只是「能不能给个 API」,多半要来回好几轮才问得清。
数据导出
如果你的需求只是把数据拿出来,而不是实时对接,往往不需要 API。后台的相关列表页支持导出,量大或需要定期导出时可以联系工作人员安排。这条路通常比接口对接快得多。