Skip to content

授权

API 请求需要在 Authorization 头部中包含 Bearer 令牌,该令牌可以从用户界面生成。

访问

API 可以通过 http://<ip>:8000/api 访问。

除了 /health/feedback 外,所有路由都额外以 /v1 为前缀,因此基础路由为 http://<ip>:8000/api/v1

生成

  1. 前往 密钥与令牌 / API 令牌
  2. 为您的令牌定义一个名称,然后点击 创建新令牌

提示

您只会看到令牌一次,因此请确保复制它并将其存储在安全的地方。

作用域

令牌只能访问由令牌所属团队拥有的资源。

php
# 示例令牌
3|WaobqX9tJQshKPuQFHsyApxuOOggg4wOfvGc9xa233c376d7

权限

注意!

如果 API 令牌没有正确的权限,某些 API 数据将不会返回

目前有三种权限类型:

  • 只读 (默认)
  • 读取敏感数据
  • 查看敏感数据
  • *(所有权限)

只读

使用此权限,您只能从 API 读取数据,但不能创建、更新或删除任何资源。您也无法查看敏感数据。

读取敏感数据

使用此权限,您只能从 API 读取数据并查看通常被隐藏的敏感信息。您无法创建、更新或删除任何资源。

查看敏感数据

没有此权限,密码、API 密钥和其他敏感数据将从 API 响应中被隐藏。

*

对所有资源和敏感数据的完全访问权限。