跳到主要内容
版本：3.10.x

从 Dashboard 获取 Token

API7 网关使用在 Dashboard 中创建的 Token 进行身份认证访问。在整个文档中，同一个 Token 既可以作为 API7 网关 Admin API 请求中的 X-API-KEY 值，也可以在使用 ADC 时作为 ADC_TOKEN。

对于日常 API 访问，请使用非 root 用户登录并为该用户创建 Token，不要使用初始 Super Admin 账号。

前提条件​

开始前，请确保：

  • API7 网关正在运行，并且可以访问 Dashboard。
  • 拥有一个非 root 用户账号，并具备管理目标资源所需的权限。

如果只有初始管理员账号，请先以 Super Admin 身份登录，创建或邀请用户并分配所需角色。然后使用该用户登录并创建 Token。详情请参阅用户管理和基于角色的访问控制。

在 Dashboard 中创建 Token​

  1. 使用非 root 用户账号登录 Dashboard。
  2. 在侧边栏中转到 Organization -> Tokens。
  3. 点击 Create Token。
  4. 输入名称和其他必填设置。
  5. 复制生成的 Token 并安全保存。

使用 Token​

在 Admin API 示例中将 Token 设置为环境变量：

export API_KEY="a7ee-xxxxxxxxxxxxx"

在 API7 网关 Admin API 请求中使用该 Token：

如果不是在本地运行，请将 localhost 替换为 Dashboard 或 Admin API 主机。

curl -k "https://localhost:7443/api/users" -X GET \
  -H "X-API-KEY: ${API_KEY}"

同一个 Token 可以用于：

  • /api/* 和 /apisix/admin/* 下的 API7 网关 Admin API 请求
  • 作为 ADC_TOKEN 进行 ADC 身份认证

安全注意事项​

  • 将 Token 视为密码，不要提交到源代码控制系统。
  • 尽可能为不同用户或自动化工作流创建独立 Token。
  • 撤销不再需要的 Token。