身分驗證

每個請求都要在 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"
  }
}

在價格頁面購買任一點數方案即可開通。點數用完後權限仍會保留,之後只需要儲值即可。

取得 API 金鑰

在設定 → API 金鑰 建立 Key。每個帳號最多可同時擁有 20 把有效的 Key,例如每台伺服器或每個環境各用一把。頁面上會顯示每把 Key 的名稱、開頭與結尾幾個字元,以及最近使用時間。

完整的 Key 只會在建立時顯示一次。我們只保存它的雜湊值,因此無法再次顯示。如果遺失了 Key,請刪除它並重新建立一把。

妥善保管 API 金鑰

  • API 金鑰 會消耗你帳號的點數,請像密碼一樣保管。
  • 從你的伺服器呼叫 API。絕對不要把 Key 放進瀏覽器、行動 App 或公開的程式碼儲存庫。
  • 從環境變數讀取 Key,例如 VIDEOUPSCALER_API_KEY。
  • 若 Key 外洩,請到「設定」中刪除,它會立即失效。

錯誤

缺少 Key、格式錯誤或 Key 已刪除時,會回傳 401:

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