TouchGal Docs

独立脱敏 Galgame Metadata API

GET /v1/me

API token 自检

验证当前 token,并返回该 token 所属应用与实际生效的请求额度。不会返回 token 明文或 token hash。

接口基础信息

接口名称

API token 自检

请求方法

GET

请求路径

/v1/me

鉴权

需要有效的 `tgal_live` API token。

请求参数

参数位置必填类型说明
AuthorizationHeader条件必填Bearer token推荐方式。值为 `Bearer <tgal_live API token>`。与 `X-API-Token` 二选一。
X-API-TokenHeader条件必填string备选方式。与 Authorization 二选一;同时传入有效 Bearer header 时优先使用 Authorization。

请求示例

业务接口不要在不可信浏览器环境暴露 token。示例 base 取自 NUXT_PUBLIC_API_BASE_URL,同源相对路径会自动拼接当前域名。

curl
curl "https://developer.touchgal.com/api/v1/me" \
  -H "Authorization: Bearer tgal_live_xxx"

返回状态码与响应示例

200

OK

token 已通过认证,且所属账号/应用允许访问公开 API。

application/json
{
  "success": true,
  "data": {
    "tokenPrefix": "tgal_live_abcd1234efgh5678ijkl90",
    "applicationId": "018f35d5-3a7f-7b90-8d72-173b6f94c3da",
    "applicationStatus": "approved",
    "minuteLimit": 60,
    "dailyLimit": 1000
  }
}

返回内容解释

success
固定为 true。
data.tokenPrefix
token 前缀,仅用于识别 token;不是可再次鉴权的 secret。
data.applicationId
token 绑定的开发者应用 UUID。
data.applicationStatus
应用状态。公开 API 可用时通常为 approved。
data.minuteLimit
token、账号、应用三维综合后的有效分钟额度。
data.dailyLimit
token、账号、应用三维综合后的有效日额度。
401

Unauthorized

缺少 API token、token 格式错误、token 已删除,或所属应用/账号不可用。

application/json
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API token"
  }
}

返回内容解释

success
固定为 false,表示请求失败。
error.code
稳定错误码,可用于客户端分支处理。
error.message
面向开发者的错误摘要,不包含内部 SQL、token、DSN 或其他敏感信息。
429

Rate limited

触发预认证 IP 限流,或触发 token、账号、应用三维之一的分钟/日限流。通过 token 认证后触发的限流响应会带 X-RateLimit-* 计数;预认证 IP 限流不会带这些响应头。

application/json
{
  "success": false,
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded"
  }
}

返回内容解释

success
固定为 false,表示请求失败。
error.code
稳定错误码,可用于客户端分支处理。
error.message
面向开发者的错误摘要,不包含内部 SQL、token、DSN 或其他敏感信息。
X-RateLimit-Limit-Minute
通过 token 认证后返回;本次认证上下文下最紧的分钟额度。
X-RateLimit-Remaining-Minute
通过 token 认证后返回;当前分钟窗口剩余额度。
X-RateLimit-Limit-Day
通过 token 认证后返回;本次认证上下文下最紧的日额度。
X-RateLimit-Remaining-Day
通过 token 认证后返回;当前日窗口剩余额度。
500

Internal error

服务端内部错误或限流依赖异常。客户端应记录 request id 并稍后重试,不应把它当作参数错误处理。

application/json
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}

返回内容解释

success
固定为 false,表示请求失败。
error.code
稳定错误码,可用于客户端分支处理。
error.message
面向开发者的错误摘要,不包含内部 SQL、token、DSN 或其他敏感信息。