跳转到内容

Authentication

Agent Analytics 使用两种不同的凭证。它们承担不同职责,不能互换。

API key 用于:

  • 读取分析数据
  • 创建或列出项目
  • 账户级端点
  • 从脚本、工具和代理中直接访问 API

可以通过 X-API-Key 头或 ?key= 查询参数传递。

Terminal window
curl "https://api.agentanalytics.sh/stats?project=my-site&since=7d" \
-H "X-API-Key: aak_..."

请把它当作密钥信息处理。

Project token 用于:

  • POST /track
  • POST /track/batch
  • 嵌入在网站中的浏览器 tracker 代码片段

这个 token 设计上就是公开的。它用于标识事件接收时对应的项目,因此本来就会出现在 HTML 中。

<script defer src="https://api.agentanalytics.sh/tracker.js"
data-project="my-site"
data-token="aat_..."></script>

不要把 API key 放进客户端 tracker 中。tracker 只使用公开的 project token。

如果你使用官方 CLI,它提供了两个围绕 API key 的本地 auth 便利命令:

  • npx @agent-analytics/cli login --token aak_...:把 API key 保存在本地,供之后的 CLI 读取使用。
  • npx @agent-analytics/cli logout:清除本地保存的 CLI auth。

logout 不会在服务器端吊销 API key。当你想让旧 key 失效并签发新 key 时,请使用 revoke-key

如果你在 shell 环境里设置了 AGENT_ANALYTICS_API_KEY,那么即使执行了 logout,CLI 仍会继续使用这个环境变量,直到你主动取消它。