Skip to main content

​
1. 获取认证凭证

根据你的使用场景，选择合适的认证方式：
适合第三方开发者、机器人客户端。
1

注册账号

前往 协议终端 注册并登录。
2

创建 API Key

进入 开发者 → API 密钥 页面，点击「创建密钥」。
3

保存密钥

复制生成的 API Key（格式：sk_xxxxxxxxxxxx）。
API Key 仅在创建时显示一次，请妥善保存。

​
2. 发送第一个请求

使用你的凭证调用健康检查接口，验证连接： 
curl https://api.end.shallow.ink/health
响应： 
{
  "code": 0,
  "message": "成功",
  "data": {
    "status": "healthy",
    "timestamp": "2026-01-26T14:00:00+08:00",
    "uptime": 123.45,
    "memory": {
      "alloc_mb": 5,
      "total_alloc_mb": 10,
      "sys_mb": 15
    },
    "runtime": {
      "version": "go1.21.0",
      "goroutines": 10,
      "os": "windows",
      "arch": "amd64"
    }
  }
}

​
3. 查询 Wiki 数据

使用认证凭证查询游戏百科数据： 
curl https://api.end.shallow.ink/api/wiki/categories \
  -H "X-API-Key: sk_your_api_key"

​
4. 查询游戏数据（需要 Framework Token）

游戏数据查询需要额外的 Framework Token（通过森空岛登录获取）： 
curl https://api.end.shallow.ink/api/endfield/user \
  -H "X-API-Key: sk_your_api_key" \
  -H "X-Framework-Token: your_framework_token"
Framework Token 是游戏数据查询凭证，通过扫码登录或手机登录获取。接口认证（API Key / JWT / Anonymous Token）和游戏数据凭证（Framework Token）是独立的两层。

​
下一步

认证详解

深入了解四种认证方式的获取和使用。

API 参考

查看完整的 API 端点列表和交互式文档。

错误码

了解所有可能的错误码及其含义。

速率限制

了解不同计划的配额和限流规则。