8W社区 API 文档

版本：v1
基础URL：https://8w.bgjq.top/api/v1/public

认证方式

所有API接口需要使用 API Key 进行认证。

请求参数

参数 类型 必填 说明
api_key string 是 API密钥，在请求URL中添加

示例

curl "https://8w.bgjq.top/api/v1/public/users?api_key=your_api_key"

用户数据接口

获取用户列表

GET /users

查询参数

参数 类型 默认值 说明
page integer 1 页码
page_size integer 20 每页数量（最大100）
role string - 按角色筛选
country_id integer - 按国家ID筛选
fields string - 返回字段（逗号分隔）

返回字段

字段 说明
id 用户ID
username 用户名
game_id 游戏ID
country 所属国家（含id和name）
role 角色
jhtuid 简幻通UID
level 等级
created_at 注册时间

请求示例

# 获取用户列表
curl "https://8w.bgjq.top/api/v1/public/users?api_key=your_api_key"

# 分页查询
curl "https://8w.bgjq.top/api/v1/public/users?api_key=your_api_key&page=1&page_size=10"

# 按角色筛选
curl "https://8w.bgjq.top/api/v1/public/users?api_key=your_api_key&role=secretary_general"

# 指定返回字段
curl "https://8w.bgjq.top/api/v1/public/users?api_key=your_api_key&fields=id,username,role"

响应示例

{
    "success": true,
    "message": "成功",
    "data": {
        "list": [
            {
                "id": 1,
                "username": "admin",
                "game_id": "Admin",
                "role": "secretary_general",
                "country": {
                    "id": 1,
                    "name": "国家名称"
                },
                "created_at": "2026-01-01 00:00:00"
            }
        ],
        "pagination": {
            "page": 1,
            "page_size": 20,
            "total": 100,
            "total_pages": 5
        }
    }
}

获取单个用户

GET /users/{id}

路径参数

参数 类型 说明
id integer 用户ID

请求示例

curl "https://8w.bgjq.top/api/v1/public/users/1?api_key=your_api_key"

国家数据接口

获取国家列表

GET /countries

查询参数

参数 类型 默认值 说明
page integer 1 页码
page_size integer 20 每页数量（最大100）
all boolean false 是否返回全部国家（不含此参数只返回活跃国家）
fields string - 返回字段（逗号分隔）

返回字段

字段 说明
id国家ID
name国家名称
declaration国家宣言
government_type政体
population人口
territory_chunks领地Chunks
flag_url旗帜URL
is_active是否活跃
joined_at加入时间
member_count成员数量

请求示例

# 获取活跃国家列表
curl "https://8w.bgjq.top/api/v1/public/countries?api_key=your_api_key"

# 获取全部国家
curl "https://8w.bgjq.top/api/v1/public/countries?api_key=your_api_key&all=true"

获取单个国家

GET /countries/{id}

统计接口

获取社区统计

GET /stats

无查询参数，返回社区整体统计数据。

返回字段

字段说明
total_users用户总数
total_countries活跃国家数
total_countries_all国家总数（含已退出）
users_by_role按角色统计的用户数
total_news新闻总数
total_proposals提案总数
proposals_by_status按状态统计的提案数
total_conventions公约总数
total_cases案件总数
cases_by_status按状态统计的案件数
active_trades活跃交易数
online_players当前在线玩家数
total_diplomatic_relations外交关系总数
diplomatic_relations_by_type按类型统计的外教关系

请求示例

curl "https://8w.bgjq.top/api/v1/public/stats?api_key=your_api_key"

角色说明

角色说明
secretary_general秘书长
permanent_member常任理事国
diplomat邦国外交官
observer观察员
peacekeeper维和部队

错误响应

错误格式

{
    "error": "错误信息"
}

状态码

状态码说明
400请求参数错误
401认证失败（API Key无效）
403权限不足
404资源不存在
405请求方法不支持
429调用频率超限
500服务器内部错误

频率限制

API管理

访问 API管理后台 创建和管理API密钥。

权限说明