跳到内容

认证

VibeVO API 的受保護參與者操作使用 API 金鑰。請求必須在標頭中攜帶有效金鑰;金鑰會識別所有者,scope 決定可存取的接口。例外是下文說明的兩個訪客創作者目錄 GET。

密钥格式

vibevo_live_{prefix}.{secret}
  • prefix — 简短的公开标识符,在后台可见。
  • secret — 密钥的秘密部分,仅在创建时显示一次。
秘密仅显示一次
创建后请立即复制完整密钥并妥善保管。若丢失,请创建新密钥并删除旧密钥。

创建密钥

密钥在后台设置页面创建 — 底部有「API 密钥」区块。为其命名、选择权限范围、可选设置有效期,然后复制完整密钥(仅显示一次)。

发送密钥

支持两种等效的请求头,任选其一:

Authorization: Bearer vibevo_live_ab12cd.xxxxxxxxxxxxxxxx
X-API-Key: vibevo_live_ab12cd.xxxxxxxxxxxxxxxx

权限范围

只有两个粗粒度权限——不按资源单独选择:

  • read — 任何 GET(广告活动、机会、数据分析、帖子、创作者、钱包、追踪链接、 工厂)。密钥始终拥有 read。
  • write — 任何写入(内容工厂、提交视频)。

例外:訪客可讀的 placement 目錄

只有 GET /api/v1/creator-catalog 與 GET /api/v1/creator-pages/{publicId} 不需要 API 金鑰。它們只回傳已發布的安全資料,不會開放草稿或訂單操作。

參與者操作使用 /api/v1/public/。讀取需要 read scope;建立、修改、上傳與確認操作需要 write scope。Core 也會檢查目前角色、帳號/頻道所有權及特定訂單權限。Write 不會授予 staff 權限,也不能取代 read。

授权错误

  • 401 Unauthorized — 密钥缺失、无效、过期或已吊销。
  • 403 Forbidden — 密钥有效,但缺少该接口所需的权限范围。

这篇文章有帮助吗?

更新日期: 2026 年 7 月 11 日

VibeVO API 认证 — API 密钥 | VibeVO Docs