Skip to Content

开发者 API

借助 TourPro 开发者 API,你编写的自动化脚本与内部集成工具可以直接读取你的巡演数据。接口采用个人访问令牌认证:每个令牌代表你本人,且只能读取你有权查看的巡演。

第一阶段(Phase 1)为只读接口:支持获取你的当前用户身份、可访问的巡演列表以及日程事件。

创建访问令牌

打开个人资料

在网页端应用中打开 个人资料(Profile),切换到 开发者(Developer) 标签页。

生成令牌

点击 创建令牌(Create token),输入便于识别用途的名称(例如将调用它的脚本或服务名),然后确认创建。

立即复制并妥善保存

出于安全考虑,令牌明文仅在创建时显示一次。请立即复制并像保管密码一样妥善保存;一旦遗失,请吊销旧令牌并重新创建。

调用 API

在请求头中以 Bearer 凭证格式携带令牌:

Authorization: Bearer tourpro_...
接口路径返回内容
GET /api/v1/me你的用户 ID、姓名与邮箱
GET /api/v1/tours你有权访问的巡演列表
GET /api/v1/tours/:tourId/events指定巡演的日程事件(已按你的角色权限与可见范围过滤)

基础 URL 为 API 主机地址(例如 https://api.tourpro.app),而非网页端应用域名。

curl https://api.tourpro.app/api/v1/tours \ -H "Authorization: Bearer tourpro_..."

API 限流规则为每个令牌每分钟最多 120 次请求。超出配额后接口会返回 429 状态码,并在 RateLimit 响应头中标明限流窗口信息。

吊销令牌

回到 开发者(Developer) 标签页,点击目标令牌旁的 吊销(Revoke) 并确认。吊销操作立即且永久生效;如需替换,请新建一个令牌。

令牌可访问的数据范围

令牌所见的数据绝不会超出你本人的权限边界:

  • 巡演:仅限你本人创建或已加入的巡演项目。
  • 事件:仅在你拥有查看日程权限时返回,且仅限该巡演中对你的角色及对应场次可见的事件。
  • 全程只读:API 中的所有接口均无法修改或删除你的任何数据。

应用内的网页登录会话不可用于调用此 API。v1 接口仅接受 tourpro_ 前缀的个人访问令牌,因此即使浏览器会话泄露也无法被重放用于调用 API。

Last updated on