为了使用 Umami Cloud 访问您的数据,您需要生成一个 API 密钥。
参考部分中的所有 API 路由都可以在 Umami Cloud 中使用 API 密钥访问,除了“禁止访问”部分列出的一些路由。
要在 Umami Cloud 中创建密钥,请前往 账户
> API 密钥
,然后点击 创建密钥
按钮。
您可以通过点击文本输入框中的 可见
图标来显示您的密钥。
您可以通过查询以下地址访问您的 Umami Cloud 数据。
https://api.umami.is/v1
只需通过自定义头 x-umami-api-key
传入您的 API 密钥。
例如,使用 curl
的情况下,命令如下:
curl https://api.umami.is/v1/websites
-H "Accept: application/json"
-H "x-umami-api-key: <api-key>"
设置以下要求变量以使 API 客户端使用您的 API 密钥。
UMAMI_API_KEY={您的 API 密钥}
UMAMI_API_CLIENT_ENDPOINT=https://api.umami.is/v1
更多有关使用 API 客户端的详细信息,请参见 API 客户端。
每个 API 密钥每 15 秒限制调用 50 次。
以下 API 路由无法使用您的 API 密钥访问。
/me/password
/users
/users/*
您可以在 账户
> API 密钥
下删除您的密钥,点击要删除的特定密钥的 删除
按钮。
一旦删除 API 密钥,将无法恢复。