本页介绍适用于每一个 Management API 端点的整体架构。完整的端点列表请见本页底部链接的各个子页面。
两个主机,两套身份验证方案
这是集成 Management API 时最常见的困惑来源,因此请在编写任何代码之前先阅读本节。
换句话说:您以您自己的身份(仪表盘登录)进行身份验证,来创建一个 Management API 密钥;而您以该密钥的身份进行身份验证,来实际使用 Management API。
快速上手
1
创建一个 Management API 密钥
在登录 Scanova 仪表盘的状态下,通过
POST /console/token/(或仪表盘的密钥管理界面,参见创建与管理 API 密钥)创建一个密钥。创建时请选择一个 environment——sandbox、live、zapier 或 mcp——这一选择对该密钥而言是永久性的,并决定了该密钥发出的每一次请求会检查哪一种套餐配额(见下文)。2
保存密钥的原始值
创建调用返回的密钥值是您唯一能够看到其完整内容的一次——请妥善保存。事后不存在任何”重新显示”的端点。
3
调用数据端点
将该密钥作为原始
Authorization 请求头的值发送给 management.scanova.io,例如通过 GET /qr/ 列出您的二维码。套餐配额
每一次对数据端点发起的请求都会检查一项与密钥的environment 绑定的套餐配额:
如果对数据主机的请求返回
401,并附带消息**“Your plan does not have management API quota”**(或 Zapier/MCP 专属的等价消息),说明您的套餐不包含该配额。目前,标准 Pro 套餐并不包含 Management API 访问权限——只有 Free Trial、Enterprise 和 Internal 套餐才包含。如果您认为自己的账户应当拥有该权限,请联系 support@scanova.io。zapier/mcp 密钥还要求调用方客户端的 User-Agent 请求头与其 environment 相匹配才能通过身份验证——zapier 密钥会拒绝除 User-Agent: zapier 之外的请求,mcp 密钥同理。这一规则独立于上文所述的配额检查,单独强制执行。
本节内容
创建一个 API 令牌
POST /console/token/ —— 为选定的 environment 生成一个新密钥。移除一个 API 令牌
DELETE /console/token/{key}/ —— 立即吊销一个密钥。用量统计
GET /console/usage/ —— 滚动时间窗口内的请求次数。列出二维码
GET /qr/ —— 大多数集成项目着手使用的核心数据端点。创建二维码
POST /qr/ —— 大多数集成项目着手使用的核心数据端点。相关内容
- API 参考简介 —— 本概览所属的上级章节。
- 创建一个 API 令牌 —— 生成整个 API 接口面据以进行身份验证的密钥。
- 列出二维码 —— 大多数集成项目着手使用的核心数据端点。
- 创建二维码 —— 大多数集成项目着手使用的核心数据端点。
- MCP 概览 —— 一个完全构建于同一 API 之上的集成,使用专属的
mcpenvironment。