跳到主要内容

开放接口列表

闪耀船首为开发者和社区应用提供标准化 RESTful 接口，支持配装方案、掉宝活动、游戏战事局势、地图点位以及用户数据同步。

接入说明​

基础地址​

所有 API 请求的基础请求地址为：

https://api.glow-prow.top/api/

鉴权机制​

  • 公开接口：无需携带认证信息即可直接请求。
  • 用户相关接口：需在 HTTP 请求头中携带 Token 凭证： 
    Authorization: Bearer <your_access_token>

统一响应格式​

{
  "code": 200,
  "message": "success",
  "data": {}
}

配装方案接口​

提供舰船配装方案的发布、检索、属性计算与详情查询。

获取公开配装列表​

  • 请求方式：GET /assembly/list
  • 鉴权要求：公开接口
  • 请求参数：
    • page (number, 可选)：页码，默认 1
    • pageSize (number, 可选)：每页数量，默认 20
    • keyword (string, 可选)：配装名称或标签关键词
    • shipType (string, 可选)：目标舰船类型过滤
    • sort (string, 可选)：排序方式（latest, hottest, rating）

获取配装详情​

  • 请求方式：GET /assembly/item
  • 鉴权要求：公开接口（私密配装需提供密码）
  • 请求参数：
    • uuid (string, 必填)：36 位配装唯一标识
    • password (string, 可选)：受保护配装的访问密码
    • force (boolean, 可选)：是否强制穿透缓存获取最新数据

发布配装方案​

  • 请求方式：POST /assembly/publish
  • 鉴权要求：需要用户 Token
  • 请求体参数：
    • name (string, 必填)：配装名称
    • shipId (string, 必填)：基础船体 ID
    • weapons (array, 必填)：武器槽位配置列表
    • armor (string, 可选)：装甲 ID
    • furnitures (array, 可选)：家具模组列表
    • isPublic (boolean, 可选)：是否公开展示，默认 true

编辑配装方案​

  • 请求方式：POST /assembly/edit
  • 鉴权要求：需要用户 Token（仅创作者可操作）
  • 请求体参数：
    • uuid (string, 必填)：配装 UUID
    • data (object, 必填)：更新后的配装数据实体

删除配装方案​

  • 请求方式：POST /assembly/delete
  • 鉴权要求：需要用户 Token（放入回收站）
  • 请求体参数：
    • uuid (string, 必填)：配装 UUID

获取配装属性详情​

  • 请求方式：GET /assembly/attr
  • 鉴权要求：公开接口
  • 请求参数：
    • uuid (string, 必填)：配装 UUID

回收站与还原​

  • 获取回收站列表：GET /assembly/trash（需要用户 Token）
  • 还原已删除配装：POST /assembly/restore（请求体携带 { "uuid": "..." }）

Twitch 掉宝接口​

提供《碧海黑帆》官方 Twitch Drops 掉宝活动实时数据与历史归档。

获取当前生效掉宝​

  • 请求方式：GET /drop/current
  • 鉴权要求：公开接口
  • 请求参数：
    • refresh (number, 可选)：传 1 时强制刷新服务端缓存

获取掉宝历史档案​

  • 请求方式：GET /drop/history
  • 鉴权要求：公开接口
  • 请求参数：
    • page (number, 可选)：页码，默认 1
    • pageSize (number, 可选)：每页条数，默认 10
    • status (string, 可选)：状态筛选（active, upcoming, ended）
    • keyword (string, 可选)：活动名称或奖励关键词

获取单个掉宝活动详情​

  • 请求方式：GET /drop/{id}
  • 鉴权要求：公开接口
  • 路径参数：
    • id (string/number, 必填)：掉宝活动 ID 或 Campaign ID

战事局势接口​

提供当前全服领地控制、势力战况与历史走势。

获取最新战事状态​

  • 请求方式：GET /stateOfWar/latest
  • 鉴权要求：公开接口
  • 返回内容：各贸易公司控制区域、势力分值及实时战线变动

获取指定赛季战事数据​

  • 请求方式：GET /stateOfWar/season/{season}
  • 鉴权要求：公开接口
  • 路径参数：
    • season (string/number, 必填)：赛季标识符或数字编号

获取可用赛季列表​

  • 请求方式：GET /stateOfWar/seasons
  • 鉴权要求：公开接口

获取历史战况走势​

  • 请求方式：GET /stateOfWar/history
  • 鉴权要求：公开接口
  • 请求参数：
    • range (string, 可选)：时间范围（1h, 1d, 7d，默认 1d）
    • season (string/number, 可选)：限定赛季

航海地图接口​

提供自定义点位、标记与地图集管理。

获取地图集列表​

  • 请求方式：GET /map/collections
  • 鉴权要求：需要用户 Token

获取地图集详情​

  • 请求方式：GET /map/collection/{uuid}
  • 鉴权要求：公开接口（非公开地图集需作者 Token）
  • 路径参数：
    • uuid (string, 必填)：地图集 UUID

创建地图集​

  • 请求方式：POST /map/collection
  • 鉴权要求：需要用户 Token
  • 请求体参数：
    • title (string, 必填)：地图集名称
    • description (string, 可选)：描述信息
    • points (array, 可选)：初始点位数组

更新与删除地图集​

  • 更新地图集：PUT /map/collection/{uuid}
  • 删除地图集：DELETE /map/collection/{uuid}

赞助与订单接口​

提供社区赞助计划、目标进度与订单查询。

获取赞助计划与档位​

  • 请求方式：GET /subscription/plans
  • 鉴权要求：公开接口

获取月度赞助目标进度​

  • 请求方式：GET /subscription/progress
  • 鉴权要求：公开接口

获取核心赞助者榜单​

  • 请求方式：GET /subscription/hall
  • 鉴权要求：公开接口

获取当前账户会员状态​

  • 请求方式：GET /subscription/my-status
  • 鉴权要求：需要用户 Token

获取当前用户订单列表​

  • 请求方式：GET /subscription/my-orders
  • 鉴权要求：需要用户 Token

创建赞助订单​

  • 请求方式：POST /subscription/orders/create
  • 鉴权要求：需要用户 Token
  • 请求体参数：
    • tierId (string, 必填)：赞助档位标识
    • payType (string, 必填)：支付渠道方式

取消待支付订单​

  • 请求方式：POST /subscription/orders/{orderId}/cancel
  • 鉴权要求：需要用户 Token

日历与活动接口​

获取赛季活动日历​

  • 请求方式：GET /calendar/data
  • 鉴权要求：公开接口
  • 请求参数：
    • season (string, 必填)：赛季标识

用户账户接口​

用户登录​

  • 请求方式：POST /user/signin
  • 请求体参数：
    • username (string, 必填)：账号或邮箱
    • password (string, 必填)：账户密码

用户注册​

  • 请求方式：POST /user/signup
  • 请求体参数：
    • username (string, 必填)：用户名
    • email (string, 必填)：电子邮箱
    • password (string, 必填)：密码
    • captchaCode (string, 可选)：图形验证码

获取当前登录用户信息​

  • 请求方式：GET /user/me
  • 鉴权要求：需要用户 Token

查询公开用户信息​

  • 请求方式：GET /user/info
  • 鉴权要求：公开接口
  • 请求参数：
    • id (string, 必填)：用户 UID

验证码接口​

获取人机验证码凭证​

  • 请求方式：GET /captcha
  • 鉴权要求：公开接口