# 查询 Key 信息

查询当前 App Key 的授权范围与绑定信息。**建议将本接口作为对接的第一个调用**，用于确认 Key 的权限边界，并排查「用错 Key」一类的问题。

<span style="display:inline-block;background:#e6f8ea;color:#22a366;border-radius:6px;padding:2px 8px;font-weight:bold;font-family:monospace;margin-right:8px;">GET</span>
`https://dashboard.avavox.com/open/api/v1/auth/key-info`

## 请求头

<span style="font-family:monospace; color:#3451b2; ">Authorization </span> <code style="background:#f0f0f0; ">string</code> <span style="background:#dc3545; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">必填</span>

- 填写格式：`Authorization: Bearer <App Key>`
- `<App Key>` 为控制台「App Key 管理」页面生成的 Key。
- 获取方式详见：[《App Key 创建与管理》](https://avavox.com/docs/developer/app-key.html)。

## 请求参数

无。

## 响应数据

<span style="font-family:monospace; color:#3451b2;">code</span> <code style="background:#f0f0f0;">int</code>

状态码，200 为成功，其他状态均为失败。

---

<span style="font-family:monospace; color:#3451b2;">success</span> <code style="background:#f0f0f0;">boolean</code>

是否成功，`true` 表示成功，`false` 表示失败。

---

<span style="font-family:monospace; color:#3451b2;">message</span> <code style="background:#f0f0f0;">string</code>

描述信息。

---

<span style="font-family:monospace; color:#3451b2;">data</span> <code style="background:#f0f0f0;">object</code>

<details>
<summary>点击展开字段说明</summary>
<div style="margin: 16px 0; padding: 16px;  border-left: 1px solid #f0f0f0; border-radius: 6px;">

<span style="font-family:monospace; color:#3451b2;">scope</span> <code style="background:#f0f0f0;">string</code>

授权范围，枚举值：

- `ENTERPRISE`：全部空间，可查询企业下所有空间的数据
- `SPACE`：仅当前空间，只能查询绑定空间的数据

---

<span style="font-family:monospace; color:#3451b2;">accountId</span> <code style="background:#f0f0f0;">string</code>

所属企业账户 ID。

---

<span style="font-family:monospace; color:#3451b2;">accountName</span> <code style="background:#f0f0f0;">string</code>

所属企业账户名称。

---

<span style="font-family:monospace; color:#3451b2;">spaceId</span> <code style="background:#f0f0f0;">string</code>

绑定空间的 ID。**仅当 `scope` 为 `SPACE` 时返回。**

---

<span style="font-family:monospace; color:#3451b2;">spaceName</span> <code style="background:#f0f0f0;">string</code>

绑定空间的名称。**仅当 `scope` 为 `SPACE` 时返回。**

</div>
</details>

## 请求示例

```shell
curl -X GET --location 'https://dashboard.avavox.com/open/api/v1/auth/key-info' \
--header 'Authorization: Bearer $Key'
```

## 响应示例

授权范围为「全部空间」的 Key：

```json
{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": {
    "scope": "ENTERPRISE",
    "accountId": "acct_10001",
    "accountName": "某某科技有限公司"
  }
}
```

授权范围为「仅当前空间」的 Key：

```json
{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": {
    "scope": "SPACE",
    "accountId": "acct_10001",
    "accountName": "某某科技有限公司",
    "spaceId": "sp_001",
    "spaceName": "花花"
  }
}
```

::: tip 为什么要先调这个接口
[账户账单](https://avavox.com/docs/developer/bill/account.html)接口在两种授权范围下响应结构完全一致，但数据口径不同：企业级 Key 返回企业总账，空间级 Key 返回单空间汇总。先确认 `scope`，才能避免把单空间数据当成企业总账。
:::