切换主题
查询 Key 信息
查询当前 App Key 的授权范围与绑定信息。建议将本接口作为对接的第一个调用,用于确认 Key 的权限边界,并排查「用错 Key」一类的问题。
GEThttps://dashboard.avavox.com/open/api/v1/auth/key-info
请求头
Authorization string 必填
- 填写格式:
Authorization: Bearer <App Key> <App Key>为控制台「App Key 管理」页面生成的 Key。- 获取方式详见:《App Key 创建与管理》。
请求参数
无。
响应数据
code int
状态码,200 为成功,其他状态均为失败。
success boolean
是否成功,true 表示成功,false 表示失败。
message string
描述信息。
data object
点击展开字段说明
scope string
授权范围,枚举值:
ENTERPRISE:全部空间,可查询企业下所有空间的数据SPACE:仅当前空间,只能查询绑定空间的数据
accountId string
所属企业账户 ID。
accountName string
所属企业账户名称。
spaceId string
绑定空间的 ID。仅当 scope 为 SPACE 时返回。
spaceName string
绑定空间的名称。仅当 scope 为 SPACE 时返回。
请求示例
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": "花花"
}
}为什么要先调这个接口
账户账单接口在两种授权范围下响应结构完全一致,但数据口径不同:企业级 Key 返回企业总账,空间级 Key 返回单空间汇总。先确认 scope,才能避免把单空间数据当成企业总账。