CCXC Backend API 参考

介绍 ccxc-backend 的 API 接口。

可以通过参考这些 API 开发自己的网站前端或是答题前端。

基本调用约定

所有的 API 均为 HTTP 接口。

除特殊说明外，均使用 POST 方法调用。

API Endpoint Base: https://api.example.com/api/v1

在域名后增加了 /api/v1 的固定前缀。之后的文档中的 PATH 前需要添加上这一前缀。

请求内容：除另有说明外，发送和返回的消息均为 JSON 格式。请求时需带有：Content-Type: application/json 的 Header。

返回内容：根据 RESTful 规则返回不同的 HTTP Code。绝大多数情况下，正常调用返回 200，失败调用返回 400。服务器报错返回 500。

除另有说明外，所有的返回消息都含有基本返回结构：

参数名	类型	说明
status	int	0-保留 1-成功 2-失败，message为错误提示 3-失败，并跳转location指定URL 4-失败并立即注销 13-成功并立即注销 31-提示前端当前用户需要激活
message	string	失败时返回错误提示
location	string	需要跳转时返回指定URL