Sparkle
  1. BTN兼容客户端协议通讯
Sparkle
  • API
    • BanHistory 封禁历史
      • 查询最近封禁记录
      • 复杂查询封禁记录
    • ClientDiscovery 客户端发现
      • 查询最近新客户端发现记录
      • 复杂查询客户端发现记录
    • Snapshot 快照记录
      • 查询最近快照
      • 复杂查询快照记录
    • UserApplication 用户应用程序
      • 列出我的用户应用程序
      • 获取指定用户应用程序信息
      • 重置指定用户应用程序的 AppSecret
      • 编辑指定用户应用程序
      • 创建新的用户应用程序
      • 删除指定用户应用程序
    • User 用户
      • 用户个人基本信息
      • 读取指定用户个人基本信息
      • 登出会话
    • Github OAuth2 登录
      GET
  • BTN兼容客户端协议通讯
    • 能力
      • 提交 Peers
      • 提交 Bans
      • 请求云端规则
    • 请求 BTN 配置文件
      GET
  1. BTN兼容客户端协议通讯

请求 BTN 配置文件

开发中
GET
/ping/config

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://btn-prod.ghostchu-services.top/ping/config'

返回响应

🟢200成功
application/json
Body
min_protocol_version
integer 
最小支持协议版本号
必需
max_protocol_version
integer 
最大支持协议版本号
必需
ability
object 
能力列表
必需
submit_peers
object 
提交 Peers
必需
submit_bans
object 
提交 Bans
必需
reconfigure
object 
重新配置
必需
rules
object 
云端规则
必需
示例
{"min_protocol_version":7,"max_protocol_version":7,"ability":{"submit_peers":{"interval":10000,"endpoint":"http://localhost:7799/ping/peers/submit","random_initial_delay":1},"submit_bans":{"interval":10000,"endpoint":"http://localhost:7799/ping/bans/submit","random_initial_delay":1},"reconfigure":{"interval":900000,"version":"196ade1f-a6d1-4f38-bbd8-6e54ef39f7f0","random_initial_delay":600000},"rules":{"interval":10000,"endpoint":"http://localhost:7799/ping/rules/retrieve","random_initial_delay":1}}}
修改于 2024-08-17 18:45:36
上一页
请求云端规则
Built with