Yeehoo 开发者

API Key 配置

一个 API Key 对应一组调用权限和一套 webhook 回调配置,建议按环境和用途拆分。

每个 API Key 当前最多配置:

  • 一个 webhook_url
  • 一个 webhook_secret
  • 一组 webhook_events
  • 一个 webhook_enabled

这套配置的意义

不是“只是多一个 URL”。

它的本质是把“这个 key 产生的异步任务,最终通知该发到哪里、怎么验签、哪些事件要推送”都挂在同一个 key 上。

这样做的好处:

  • 测试 key 和正式 key 可以走不同回调地址
  • 不同客户的 key 可以各自回调到自己的系统
  • 一个 key 同时保留轮询能力,不会和 webhook 冲突

推荐拆分方式

建议至少按下面方式拆分:

  • 测试环境一个 key
  • 正式环境一个 key
  • 如果有多租户或多客户,再按客户拆 key

API Key 和会话能力的关系

当前对外 API Key 主要服务于这些能力:

  • 图片任务
  • 视频任务
  • 任务查询与取消
  • OpenAI 兼容文本接口
  • webhook 回调

当前不建议把“前端内部持久化会话”直接作为外部 API Key 的主承诺能力。

当前建议

  • 测试环境单独建 key
  • 正式环境单独建 key
  • 每个 key 使用独立 webhook_secret
  • 不同业务线尽量不要共用同一个正式 key

On this page