开发者文档

注意事项及常见问题

注意事项

1)请求时请按照本页面中的请求方式和参数进行请求

2)完美校园开放平台目前只支持HTTPS的POST或者GET请求方式,一般情况下每个接口都会写上请求类型。请求过程如果遇到请求错误问题, 目前完美校园开放平台使用HTTP的状态码来标识请求状态是否正常,如果HTTP状态码为200则表示请求返回正常,如果不是200则都可以视为失败。

3)若 HTTP 状态码不为 200,请参考开发规范:HTTP状态码和错误消息定义。 如果您还有其他问题,请您联系我们。

常见问题

Q:请问AccessToken的有效期是多久?

A:OAuth2.0对于已审核应用有效期最低为14天,不同的应用级别有效期不同,详见:授权机制。

Q:为什么不提供直接用完美校园用户的账号密码直接登录的接口?

A:完美校园 OpenAPI 可以由任何个人开发者使用, 假如提供用完美校园用户密码登录的授权 验证方式,会带来 2 个问题:
1)从拥有资源的完美校园用户的角度上看,把自己完美校园账号密码交给不被信任的第三方应用,有泄露的风险。
2)用户有权知晓那些第三方开发者从完美校园获取了自己的信息。假如用户某天想取消对某个应用的授权, 可以使用自己的意愿直接在本平台进行取消授权。
OAuth 协议就是为了解决上述问题而存在的授权协议。它可以在用户不告知应用密码 的情况下,让第三方应用能访问到自己的资源,为用户更好的提供服务。

Q:为什么有的接口,请求后返回 405 NotAllowed?

A:一般出现这种情况,请查看文档,对照自己的程序,确定是GET请求还是POST请求。 如上述情况都满足但仍然有错误,可以把相关HTTP包的完整信息截取,到完美校园开发者论坛上发帖子提问。

Q:回调地址必须是外网地址吗?

A:是。

Q:回调地址没有外网怎么办?

A:没有外网地址,可以使用反向代理工具,例如:花生壳/ngrok。

Q:回调地址必须是80端口吗?

A:不需要。在调试阶段可以使用任何端口,正式环境也没有限制,但是建议上线时尽量使用80端口。

Q:开发者access token和用户access token有什么区别?

A:开发者使用access token是开发者用来统计自己应用的信息用的,没有用户相关的信息,使用开发者access token不能调用用户相关的接口。开发者access token没有refresh token,而且失效时间为1小时,如果超时请自行维持。 注意两者不能混用,请参考文档使用相应的access token调用接口。