Skip to content

System API

/get-default-setting

  • 用途:获取系统初始设置信息(在主站首页加载时调用)
  • 认证:无
  • 输入参数:无
  • 输出参数
    参数名类型说明
    project_namestring项目名称
    statusint状态码
    start_timelong开始时间(时间戳)
    start_typeint0-未开始,1-已开始 (未开始时需弹出确认锁定提示)
    guest_modeint1-游客模式,0-非游客

/heartbeat

  • 用途:主站心跳
  • 认证:无
  • 输入参数:无
  • 输出参数
    参数名类型说明
    statusint状态码

/heartbeat-puzzle

  • 用途:答题前端心跳,返回未读公告和新消息数
  • 认证:比赛中
  • 输入参数:无
  • 输出参数
    参数名类型说明
    statusint状态码
    unreadint未读公告数
    new_messageint新消息数

/heartbeat-inner

  • 用途:ws心跳,这个接口只会由 ccxc-sync-server 调用。返回指定队伍的未读消息数。
  • 认证:仅限 ccxc-sync-server 内部调用
  • 输入参数
    参数名类型说明
    gidint组ID
    tokenstring内部校验token
  • 输出参数
    参数名类型说明
    statusint状态码
    new_messageint新消息数

/get-sso-prefix

  • 用途:获取SSO登录前缀
  • 请求方式:GET
  • 认证:无
  • 输入参数:无
  • 输出参数
    参数名类型说明
    statusint状态码
    prefixstringSSO前缀
    ws_prefixstringWebSocket 服务器连接前缀

/get-scoreboard-info

  • 用途:获取计分板信息
  • 认证:无
  • 输入参数:无
  • 输出参数
    参数名类型说明
    cache_timeDateTime缓存时间
    finished_groupsarray已完成组列表
    groupsarray所有组列表
    extra_flagstring附加标志
    extra_datastring附加数据
    • finished_groupsgroups 内部的结构
      参数名类型说明
      gidint组ID
      group_namestring组名
      group_profilestring队伍简介
      is_finishint0-未完成 1-已完成
      total_timenumber完成用时(小时)
      aint完成分组数量
      bint完成题目数量
      metaint完成meta数量
      percentnumber完成进度
      usersarray队伍中用户列表
      • users 内部的结构
        参数名类型说明
        is_leaderint1-队长 0-队员
        usernamestring用户名
        avatar_hashstring用于展示用户头像的Hash值
        theme_colorstring主题色

Released under the MIT License. Powered by VitePress.