Tooli Suite登录

草稿,等待所有者审核。尚未发布,也不会被搜索引擎收录。

Tooli Suite 的 API 和 Webhook

用途

API 让您自己的工具读取 Tooli Suite 为您的组织保存的内容:文档、网站、访客和事件记录,数字与应用中显示的一致。Webhook 会在事件发生时,把每一次查看、点击和访问发送到您的服务器。所有路由、筛选条件和字段都列在 API 参考中,每次测试 Tooli Suite 时,参考都会与正在运行的 API 核对。

Tooli Suite 不运行任何 AI 模型。API 是供您自己的程序使用的入口,使用的是您组织自己的密钥。

创建密钥

所有者和管理员可以在组织 → API 中创建密钥。

  1. 选择新建密钥,并说明谁会使用它。
  2. 选择它能做什么:只读,或者读写。目前所有路由都是读取,所以大多数工具只需要只读密钥。
  3. 复制密钥。它只显示一次,之后只保留最后四个字符供查看。

每次请求都在 Authorization 请求头中带上密钥:

curl -H "Authorization: Bearer $TOOLI_API_KEY" https://track.tooli.dev/api/v1/organization

密钥能读取的内容与组织的管理员能看到的一致。它只在 /api/v1/ 下有效,而登录应用的身份在那里永远无效。

轮换或撤销

  • 轮换密钥会生成一个名称和权限相同的新密钥。旧密钥还能使用 24 小时,然后停止,让您有一天时间更新使用它的程序。
  • 撤销会立即停用密钥。

限制

每个密钥每分钟可以发出一定数量的请求;超出后,应答为 429,并带有 Retry-After 请求头。具体数字见参考。列表分页返回:把应答中的 next 作为 cursor 传回,即可获取下一页。

Webhook

在组织 → API 中选择添加 Webhook,填写要发送到的 https 地址,并选择事件:邮件被查看、链接被点击、文档被查看、网站的一次访问开始。每个组织最多可以有 10 个 Webhook。

每次投递都按 Standard Webhooks 规范签名,您可以用已有的库来验证:三个请求头 webhook-id、webhook-timestamp 和 webhook-signature,签名是用 Webhook 的密钥对 ID、时间和正文计算的 HMAC-SHA-256。请拒绝时间与您自己的时钟相差太远的投递,并丢弃已经处理过的 ID。轮换签名密钥后的 24 小时内,投递会同时用新旧两个密钥签名。

投递失败后会重试,每次等待的时间更长;参考中列出了等待时间。连续三天没有任何投递成功的 Webhook 会被关闭,其页面上会注明。

导出

已跟踪的邮件、链接、文档、网站、访客和事件记录都可以导出为 CSV 文件,导出时沿用列表的筛选条件,并且只包含您有权查看的内容。链接页面可以导出它的点击,文档页面可以导出它的查看,网站页面可以导出它的页面浏览。