System API
/get-default-setting
- 用途:获取系统初始设置信息(在主站首页加载时调用)
- 认证:无
- 输入参数:无
- 输出参数:
参数名 类型 说明 project_name string 项目名称 status int 状态码 start_time long 开始时间(时间戳) start_type int 0-未开始,1-已开始 (未开始时需弹出确认锁定提示) guest_mode int 1-游客模式,0-非游客
/heartbeat
- 用途:主站心跳
- 认证:无
- 输入参数:无
- 输出参数:
参数名 类型 说明 status int 状态码
/heartbeat-puzzle
- 用途:答题前端心跳,返回未读公告和新消息数
- 认证:比赛中
- 输入参数:无
- 输出参数:
参数名 类型 说明 status int 状态码 unread int 未读公告数 new_message int 新消息数
/heartbeat-inner
- 用途:ws心跳,这个接口只会由
ccxc-sync-server
调用。返回指定队伍的未读消息数。 - 认证:仅限
ccxc-sync-server
内部调用 - 输入参数:
参数名 类型 说明 gid int 组ID token string 内部校验token - 输出参数:
参数名 类型 说明 status int 状态码 new_message int 新消息数
/get-sso-prefix
- 用途:获取SSO登录前缀
- 请求方式:GET
- 认证:无
- 输入参数:无
- 输出参数:
参数名 类型 说明 status int 状态码 prefix string SSO前缀 ws_prefix string WebSocket 服务器连接前缀
/get-scoreboard-info
- 用途:获取计分板信息
- 认证:无
- 输入参数:无
- 输出参数:
参数名 类型 说明 cache_time DateTime 缓存时间 finished_groups array 已完成组列表 groups array 所有组列表 extra_flag string 附加标志 extra_data string 附加数据 finished_groups
与groups
内部的结构参数名 类型 说明 gid int 组ID group_name string 组名 group_profile string 队伍简介 is_finish int 0-未完成 1-已完成 total_time number 完成用时(小时) a int 完成分组数量 b int 完成题目数量 meta int 完成meta数量 percent number 完成进度 users array 队伍中用户列表 users
内部的结构参数名 类型 说明 is_leader int 1-队长 0-队员 username string 用户名 avatar_hash string 用于展示用户头像的Hash值 theme_color string 主题色