僅限預覽 — 需要啟用

使用 downf.io 建立下載

DownF 會保持 API 執行停用，直到操作員審查相容性使用案例。範例描述了計劃中的合約，而真實憑證和配額僅透過支援啟用提供。

DownfBridgeHTTPS 上的 JSON非同步工作範圍限定的憑證

快速開始

DownF 以支援啟用的憑證組織 API 主機。其相容性視圖比較指定的租戶端點。僅伺服器呼叫路徑仍為最終檢查。

租戶網址https://downf.io

身份驗證X-API-Key: pending_activation_…

用戶端設定檔DownfBridge

API 版本v1

# Available only after support activation
export DOWNF_ACCESS_TOKEN="issued-after-review"

curl -X POST https://downf.io/v1/resolve \
  -H "X-API-Key: $DOWNF_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"media_address":"https://www.youtube.com/watch?v=VIDEO_ID"}'

憑證安全始於 DownF 的伺服器端秘密存儲。此相容性視圖不包含任何客戶端套件嵌入。最終事實是沒有公開日誌或存儲庫。

解析連結

DownF 將 Resolve 操作圍繞來源偵測組織。其相容性檢視比較來自單一提交 URL 的格式。未經創建的輸出仍是最終檢查。

發佈/v1/resolve範圍：解析

欄位	類型	必填	描述
`media_address`	HTTPS 網址	是	公開或授權的媒體頁面進行分析。
`tenant`	字串	否	指定的租戶網域。通常省略。

{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

格式識別碼在 DownF 上以返回值不變開始。此相容性視圖接著呈現每個連結的可用性。最終事實是不猜測品質標籤。

建立並追蹤下載工作

工作建立在 DownF 以非同步準備開始。下一個檢視涵蓋短暫的 HTTP 請求。頁面保持有界工作執行可見。

發佈/v1/jobs範圍：工作

欄位	類型	必填	描述
`media_address`	HTTPS 網址	是	提交相同的標準化來源以進行解析。
`output_ref`	字串	是	解析回應中的精確 ID。
`tenant`	字串	否	指定的租戶網域。通常省略。

curl -X POST https://downf.io/v1/jobs \
  -H "X-API-Key: $DOWNF_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"media_address":"https://www.youtube.com/watch?v=VIDEO_ID","output_ref":"18"}'

1202 已接受儲存 transfer_ref.

2投票狀態GET /v1/jobs/{transfer_ref} 使用相同的金鑰。

3準備好開啟已簽署的下載網址。

狀態	意義	客戶操作
`queued`	已加入有界佇列。	再次投票並退避。
`extracting`	正在刷新來源元資料或路由。	繼續輪詢。
`processing`	下載、重封裝或合併。	顯示伺服器進度。
`ready`	已提供簽署下載。	將 URL 傳送給使用者。
`failed`	終端結構化錯誤。	閱讀 `error_code`. 僅在建議時重試。
`expired`	暫時輸出已被移除。	建立新工作。

curl https://downf.io/v1/jobs/TRANSFER_REF \
  -H "X-API-Key: $DOWNF_ACCESS_TOKEN"

DownF 的相容性檢視會檢查工作輪詢的一秒初始等待時間。它顯示限制的退避時間，且不會遮蔽臨時簽署的交付。

可預測的錯誤

DownF 提出錯誤合約的三個實用要點。首先是一個非 2xx 的信封。相容性視圖接著涵蓋支援請求 ID。最後一點是可預測的客戶端處理。

{
  "success": false,
  "error": {
    "code": "RATE_LIMITED",
    "category": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "retryable": true,
    "details": {"retry_after_seconds": 20}
  },
  "request_id": "…"
}

HTTP	典型含義	動作
400	無效的 URL、內容或格式不可用。	修正請求。重新解析格式。
401	缺少、無效、過期或範圍錯誤的金鑰。	檢查伺服器端憑證。
403	租戶或來源政策拒絕了請求。	請勿繞過政策。請聯絡支援。
404	未知或已過期的工作。	如適用，請建立一個新工作。
429	已達請求或進行中工作限制。	榮譽 `retry_after_seconds`.
503	佇列/容量或上游暫時無法使用。	使用指數退避和抖動重試。

操作合約

DownF 在審查預定客戶端後設定請求上限，保持其相容性檢查和上游供應商的穩定。

使用冪等的應用程式邏輯，切勿為同一使用者點擊啟動重複的工作。
暫時快取解析的元資料，但始終將簽署的下載 URL 視為會過期。
對…使用帶抖動的有界指數退避 429, 503 以及可重試的錯誤。
僅處理公開媒體或您有權訪問的媒體。不會繞過 DRM 和存取控制。
在私人操作日誌中保留請求 ID 和工作 ID。請勿不必要地記錄提交的 URL。

DownF 將 Schema 存取組織在啟動之前的探索周圍。其相容性視圖比較分配的身份驗證。文件化的請求形狀仍然是最終檢查。

經營者審核存取

透過客服啟用

描述產品，預測其每月呼叫次數，並列出必須分析的平台。DownF 支援將在發出一次性可見憑證前確認所需範圍，該憑證的儲存副本僅為雜湊值。

請求啟用金鑰是租戶範圍內的，可撤銷，並通過聯絡表單發行。匿名腳本無法執行下載器工作。