API 密钥

为了使用 Umami Cloud 访问您的数据，您需要生成一个 API 密钥。

参考部分中的所有 API 路由在 Umami Cloud 中均可使用 API 密钥访问，除了 不允许 部分列出的一些路由。

创建您的密钥#

登录后，点击侧边导航中的个人资料按钮，然后点击 设置。

导航到 API 密钥，然后点击 创建密钥 按钮。

您可以点击文本输入框中的 visible 图标来显示您的密钥。

使用您的密钥#

您可以通过访问以下地址来获取 Umami Cloud 数据。

https://api.umami.is/v1

在 Authorization 标头中使用 Bearer 身份验证方案传递您的 API 密钥。

例如，使用 curl 命令如下：

curl https://api.umami.is/v1/websites \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <api-key>"

在 API 客户端中使用您的密钥#

设置以下环境变量，使 API 客户端使用您的 API 密钥。

UMAMI_API_KEY={您的 API 密钥}
UMAMI_API_CLIENT_ENDPOINT=https://api.umami.is/v1

更多关于使用 API 客户端的详细信息，请参见 API 客户端。

区域#

区域将默认为拥有 API 密钥的账户所在的区域。您可以通过将区域作为第一个路径添加到 API 调用来指定区域。

https://api.umami.is/v1/us

https://api.umami.is/v1/eu

限制#

每个 API 密钥限制为每 15 秒最多 50 次调用。

不允许#

以下 API 路由不支持通过您的 API 密钥访问。

/me/password
/users
/users/*

删除您的密钥#

在 API 密钥页面，点击对应密钥的 删除 按钮。

API 密钥一旦被删除，将无法恢复。