跳到主要内容

API 密钥

每个请求都带密钥：

Authorization: Bearer vmk_...

密钥形状是 vmk_<id>_<secret>。secret 只在签发或轮替时显示一次；纪录只保存 <id>，可在工单中分享。

安全保存​

  • 放在环境变量（VEINMESH_API_KEY）或密码管理器。不要放程序、notebook、Git、 截屏或聊天。
  • 每个人一把，每个 agent 或自动化流程各一把，外泄时才能单独撤销。
  • 撤销后约一分钟内失效。已打开的 WebSocket 会收到错误并关闭。
  • 效期与轮替重叠见限制。

密钥能读什么​

密钥的 scope 与 principal 的 grant 共同决定可读范围。/v2 目前强制：

功能需要
目录、日历、schema任何有效密钥
盘口快照（/v2/data）book_snapshot kind、history、盘口档数
K 线（/v2/bars）history，以及 bar 或 book_snapshot kind
导出（/v2/exports）上述快照权限加 export
实时（/v2/stream）book_snapshot kind、live、盘口档数

密钥也带交易所与商品 scope，但 /v2 目前尚未套用。已套用的是数据种类、历史、 实时、导出与盘口档数。

被拒（403 forbidden）会指出缺少哪一项。请管理员做最小幅度的调整。

检查密钥​

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  https://data.cyberun.cloud/v2/whoami

响应含密钥纪录（不含 secret）、principal 与密钥目前的数据权限。venues 与 instruments 是声明的 scope：它们记在密钥上，但尚未应用到 /v2 请求。kind、 history、live、export 与盘口档数则强制执行。v1 数据 API 虽已退役， /v2/whoami 仍是目前的身分端点。

轮替与撤销​

轮替与撤销是管理操作；请管理员处理。轮替会签发同 scope、同效期的新密钥，旧 密钥在重叠期后失效。没有重叠时，旧密钥立即失效。

密钥外泄时，撤销比轮替安全：轮替在重叠结束前仍让旧 secret 有效。管理员可用 管理的端点做这两件事。