跳到主要内容

客户端 API（Public Client API）

客户端 API（Public Client API）基址为 /api/public/v1，用于客户端接入。

鉴权​

所有接口都要求客户端 API Key（Public API Key）：

X-Yuzuca-Key: <PUBLIC_API_KEY>

登录后的 me/* 接口还要求客户访问令牌：

Authorization: Bearer <ACCESS_TOKEN>

登录后的接口还需要在 Authorization 中传入当前客户的访问令牌。

访问范围​

客户端 API 仅面向当前登录客户本人：

  • 只能读取自己的资料、订阅、用量、历史和卡密记录
  • 只能为自己兑换卡密
  • 只能校验自己的功能权限
  • 不能读取其他客户信息
  • 不能修改其他客户订阅、配额或卡密状态

端点列表​

匿名接口：

  • GET /api/public/v1/info
  • POST /api/public/v1/auth/login
  • POST /api/public/v1/auth/refresh

登录态接口：

  • POST /api/public/v1/auth/logout
  • GET /api/public/v1/me
  • GET /api/public/v1/me/subscriptions
  • GET /api/public/v1/me/subscriptions/:subscriptionId
  • GET /api/public/v1/me/subscriptions/:subscriptionId/usages
  • GET /api/public/v1/me/subscriptions/:subscriptionId/usages/:featureId/history
  • GET /api/public/v1/me/license-codes
  • POST /api/public/v1/me/redemptions
  • POST /api/public/v1/me/entitlements/check

接口文档​