文档

更快上手 TicketsX

配置指南、完整命令说明、Premium 功能和 REST API 都在这里。

13.1

身份验证

API 令牌在 TicketsX 控制台的服务器侧边栏中创建和管理。每个令牌只绑定一个服务器,创建和使用都需要该服务器拥有有效的 Premium 订阅。

创建令牌

  • Premium 页面为服务器开通 Premium(API 访问页面有直达链接)。
  • 打开服务器侧边栏,进入 API 访问
  • 给令牌取个名字(例如“客服机器人”或“CRM 同步”)。
  • 点击创建令牌,复制显示出来的值。
  • 把它保存到密钥管理工具里;关闭提示条之后就再也看不到了。

如果 Premium 到期

你的令牌不会被删除。在订阅重新生效之前,所有 API 请求都会返回 402premium_required: true,并且无法创建或轮换令牌。列出、停用和吊销仍然可用,方便你在此期间做清理。在你的集成中,请像处理 401 一样处理 402:停止重试并通知人工。

服务器没有 Premium 时的响应
{
  "error": "The TicketsX REST API is a Premium feature. Activate Premium for this server to use API tokens.",
  "premium_required": true
}

吊销令牌会立即在所有接口上失效。如果不希望有中断,请先创建一个替代令牌。

使用令牌

每个请求都要在 Bearer 头中带上令牌。所有请求都只作用于创建该令牌的那个服务器。

带身份验证的请求示例
curl -X GET \
  -H "Authorization: Bearer <API_TOKEN>" \
  https://api.ticketsx.xyz/<guild_id>/api/tickets