Skip to main content
POST
创建一个新的 Management API 密钥。此端点位于常规的 Scanova API 主机(qcg-api.scanova.io)上,其身份验证方式与任何其他已登录仪表盘请求相同——使用 OAuth 访问令牌,而非 Management API 密钥。
这是您唯一需要从可信上下文中、以自己的登录身份发起的 Management API 相关调用,而不是从将要使用生成密钥的那个集成程序中发起。完整的双主机架构请参见概览

请求

请求体参数

string
必填
该密钥的人类可读标签,例如 "Zapier — production"。会显示在仪表盘的密钥列表中,方便您区分不同密钥。
string
默认值:"sandbox"
sandboxlivezapiermcp 之一。在密钥的整个生命周期内保持不变——决定了该密钥发出的每一次数据主机请求会检查哪一种套餐配额,以及对于 zapier/mcp 密钥,调用方客户端必须发送哪种 User-Agent 请求头。完整的映射关系参见套餐配额
integer
默认值:"-1"
-1(永不过期)、3090365 之一——创建后经过多少天该密钥停止生效。没有办法延长现有密钥的有效期;请创建一个新密钥。

响应字段

string
原始的 Management API 密钥。这是唯一一次响应会返回完整的密钥值——不存在事后重新显示/获取的端点,请立即妥善保存。
string | null
根据 created 加上 expiry 天数计算出的绝对到期时间戳,当 expiry-1(永不过期)时为 null
boolean
该密钥是否已经过了其 expiry_date。已过期的密钥在数据主机上身份验证会失败,但不会被自动删除——如果您想将其从列表中移除,请通过 DELETE /console/token/{key}/ 显式删除。
integer
此特定密钥在其整个历史中被使用的请求次数总计。这与下方用量端点返回的、汇总同一 environment 下所有密钥的聚合数字不同。

列出现有令牌

同样的 console/token/ 路径也接受 GET(无需请求体)来列出账户上的每一个密钥,每个条目返回与创建响应相同的数据结构。您可以按 environment 筛选:GET /console/token/?environment=live
创建和列出令牌都会使用请求中的 environment 重新检查套餐配额——创建时是请求体字段,列出时是查询参数,若省略则默认为 sandbox。如果您的套餐在 sandbox 和 live 之间的配额不同,在列出 live environment 的密钥时请显式传入 ?environment=live,否则默认会检查 sandbox 配额。

相关内容

授权

Authorization
string
header
必填

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

响应

201

Token created