快速开始

1. 获取 API Key

获取 API Key 用于接口请求认证

注册账号

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

创建 API Key

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

保存密钥

复制生成的 API Key（格式：ef_xxxxxxxxxxxx）。

API Key 请勿泄露，避免无故滥用。

2. 发送第一个请求

使用你的凭证调用健康检查接口，验证连接：

curl https://api.end.shallow.ink/health

const response = await fetch('https://api.end.shallow.ink/health');
const data = await response.json();
console.log(data);

import requests

response = requests.get('https://api.end.shallow.ink/health')
print(response.json())

resp, err := http.Get("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: your_api_key"

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

游戏数据查询需要额外的 Framework Token（通过森空岛登录获取）：

curl https://api.end.shallow.ink/api/endfield/user \
  -H "X-API-Key: your_api_key" \
  -H "X-Framework-Token: your_framework_token"

Framework Token 是游戏数据查询凭证，通过扫码登录或手机登录获取。接口认证（API Key / JWT / Anonymous Token）和游戏数据凭证（Framework Token）是独立的两层。

下一步

凭证体系

分清楚接口凭证和游戏数据凭证。

API 参考

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

错误码

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

速率限制

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

开始使用

核心概念

使用指南

1. 获取 API Key

2. 发送第一个请求

3. 查询 Wiki 数据

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

下一步

凭证体系

API 参考

错误码

速率限制

​1. 获取 API Key

​2. 发送第一个请求

​3. 查询 Wiki 数据

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

​下一步

凭证体系

API 参考

错误码

速率限制

1. 获取 API Key

2. 发送第一个请求

3. 查询 Wiki 数据

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

下一步