入门
身份验证
On this page
以下身份验证方法仅适用于自托管的 Umami。对于 Umami Cloud,您只需生成一个 API 密钥。
首先,您需要获取一个 token 才能进行 API 请求。您需要向 /api/auth/login
端点发送一个 POST
请求,数据如下:
{
"username": "您的用户名",
"password": "您的密码"
}
如果成功,您应该会收到如下响应:
{
"token": "eyTMjU2IiwiY...4Q0JDLUhWxnIjoiUE_A",
"user": {
"id": "cd33a605-d785-42a1-9365-d6cad3b7befd",
"username": "您的用户名",
"createdAt": "2020-04-20 01:00:00"
}
}
保存 token 值,并在所有数据请求中发送 Authorization
头,值为 Bearer <token>
。您的请求头应如下所示:
Authorization: Bearer eyTMjU2IiwiY...4Q0JDLUhWxnIjoiUE_A
例如,使用 curl
时如下所示:
curl https://{您的服务器}/api/websites
-H "Accept: application/json"
-H "Authorization: Bearer <token>"
授权 token 在每一个需要权限的 API 调用中都是必须的。
您可以验证 token 是否仍然有效。
示例响应
{
"id": "1a457e1a-121a-11ee-be56-0242ac120002",
"username": "umami",
"role": "admin",
"isAdmin": true
}