身份验证

每个请求都需在 Authorization 请求头中携带私密 API 密钥 进行身份验证。

每个请求都需要携带 API 密钥,以 Bearer Token 的形式发送:

Authorization: Bearer vu_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

谁可以使用 API

API 面向付费账号,即购买过积分包或订阅过的账号。免费账号无法创建 API 密钥,从未付费过的账号发出的每个请求都会返回 403:

{
  "error": {
    "code": "paid_plan_required",
    "message": "The API is available to accounts that have bought credits or subscribed. See https://videoupscaler.co/pricing"
  }
}

在价格页面购买任意积分包即可获得访问权限。积分用完后权限依然保留,之后只需充值即可。

获取 Key

在设置 → API 密钥 中创建 Key。每个账号最多可同时拥有 20 个有效 Key,例如每台服务器或每个环境各用一个。页面会显示每个 Key 的名称、首尾几位字符以及最近使用时间。

完整的 Key 只在创建时显示一次。我们只保存它的哈希值,因此无法再次显示。如果 Key 丢失,请删除后重新创建。

保管好你的 Key

  • Key 会消耗你账号的积分,请像对待密码一样保管它。
  • 请在服务端调用 API。切勿把 Key 放进浏览器、移动应用或公开代码仓库。
  • 从环境变量中读取 Key,例如 VIDEOUPSCALER_API_KEY。
  • 如果 Key 泄露,请在设置中删除它,删除后立即失效。

错误

缺少 Key、格式错误或 Key 已被删除时,返回 401:

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key. Send it as \"Authorization: Bearer vu_live_...\"."
  }
}