跳转到内容

使用开发者 API 和 Webhook

控制台中的“API”页面用于以编程方式访问数字人、声音、音频和视频生成。打开“控制台 → API”,可查看当前基础 URL、鉴权格式、API 密钥管理、Webhook 设置以及完整开发者参考文档链接。

谁可以创建 API 密钥

开发者 API 仅对付费套餐开放。若 API 密钥卡片提示需要套餐,请先在“账单”中升级,再创建密钥。API 访问与普通控制台登录应分开理解:API 密钥是供软件使用的秘密凭据,不是可以分享给他人的密码。

创建并保存 API 密钥

  1. 打开“控制台 → API”,找到“开发者 API”卡片。

  2. 输入易识别的密钥名称,例如“生产后端”或“预发布集成”,然后选择“创建”。

  3. 立即复制完整密钥,并将其保存到部署环境的密钥管理器或受保护的环境配置中。

  4. 关闭一次性展示后,控制台只保留前缀和使用元数据,完整密钥无法再次查看。

API 密钥相当于可消耗账户积分的密码。不要把它放进浏览器代码、移动应用、截图、聊天消息、公开仓库或客户端环境变量。

为请求鉴权

API 页面会显示当前基础 URL 和 Authorization 请求头格式。请只从受信任的服务器端代码中使用 Authorization: Bearer <key> 发送密钥。构建集成前,请查阅开发者参考文档中的端点、请求体、任务轮询、响应格式、速率限制和当前错误码。

轮换或吊销密钥

  1. 可以安全操作时,先创建并部署替代密钥。

  2. 更新所有使用旧密钥的服务,并确认请求成功。

  3. 在“控制台 → API”的旧密钥旁使用吊销操作。

吊销不可撤销。不要因为想再次查看完整值而吊销密钥;应创建一个替代密钥。

配置生成 Webhook

  1. 在“控制台 → API”的 Webhook 卡片中填写你自己服务器控制的公共 HTTPS 地址。

  2. 选择“保存”。保存新的或变更后的端点时可能一次性显示 Webhook 密钥;请立即复制并保存。

  3. 在服务器端,使用该密钥对原始请求体计算 HMAC-SHA256,并与 X-Odrazio-Signature 请求头比较,验证通过后再接受事件。

  4. 使用事件触发服务器端拉取相应资源或更新任务记录。未经验证的入站请求不能作为生成已完成的证明。

更改或移除 Webhook

保存变更后的 Webhook URL 可能会轮换密钥,因此应同时更新验证配置。不再需要投递时使用“移除”。有效地址必须能通过公共 HTTPS 访问;仅本地开发地址无法接收平台回调。