API

认证

自托管版 Umami 支持两种 API 请求认证方式。推荐使用 API 密钥。用户名和密码认证仍作为替代方案受支持。

对于 Umami Cloud,API 密钥是唯一的认证方式。请参阅 API 密钥。

API 密钥(推荐)#

API 密钥是适合程序化访问的长期凭据。它们不会过期,并且可以单独撤销。

创建密钥#

在应用中点击个人资料图标,选择 Settings,然后进入 API keys 生成密钥。点击 Create key 并保存其值,因为它只会显示一次。

您也可以通过程序创建、列出和删除密钥:

使用密钥#

使用 Bearer 认证方案,通过 Authorization 请求头传入密钥。

request

例如,使用 curl 时如下所示:

用户名和密码(替代方式)#

如果您愿意,仍可以通过用户名和密码换取临时令牌进行认证。

POST /api/auth/login#

首先,您需要获取一个 token 以进行 API 请求。您需要向 /api/auth/login 端点发送一个包含以下内容的 POST 请求:

如果成功,您应该会收到如下响应:

保存 token 值,并在所有数据请求中通过 Authorization 头发送,格式为 Bearer <token>。您的请求头应该如下所示:

request

例如,使用 curl 时如下所示:

带权限的 API 调用均需包含此授权 token。

POST /api/auth/verify#

您可以验证令牌是否仍然有效。

示例响应