跳到主要内容

服务端 API（Private API）

服务端 API（Private API）基址为 /api/private/v1，用于服务端接入。

鉴权​

Authorization: Bearer <PRIVATE_API_KEY>

仅接受 PRIVATE 类型 API Key，也就是服务端 API Key。

适用范围​

服务端 API 支持项目级操作，包括：

  • 访问项目内任意客户
  • 创建、修改、删除客户
  • 激活、删除任意订阅
  • 扣减、返还或直接设置任意客户的计量用量
  • 为任意客户兑换卡密

请仅在可安全保管密钥的服务端环境中使用。

端点列表​

  • GET /api/private/v1/info
  • POST /api/private/v1/entitlements
  • POST /api/private/v1/usage
  • POST /api/private/v1/redemptions
  • GET /api/private/v1/customers
  • POST /api/private/v1/customers
  • GET /api/private/v1/customers/:username
  • PATCH /api/private/v1/customers/:username
  • DELETE /api/private/v1/customers/:username
  • GET /api/private/v1/plans
  • GET /api/private/v1/subscriptions
  • GET /api/private/v1/subscriptions/:subscriptionId
  • DELETE /api/private/v1/subscriptions/:subscriptionId
  • POST /api/private/v1/subscriptions/activate
  • POST /api/private/v1/codes/redeem

接口文档​