PRODUCTION REST API · v1 プロダクションREST APIの概要

YTSave でビルドダウンロード

パブリックメディア URL を解決し、正確なフォーマットを選択し、非同期ジョブを作成し、署名された結果をユーザーに渡します。 同じ境界付きプロダクション パイプラインが YTSave ウェブサイトを動作させます。

YTSaveClientHTTPS 経由の JSON非同期ジョブスコープ付き認証情報
01

クイックスタート

YTSave は、サポートが有効化された認証情報を最初に識別することで API ホストを処理します。 割り当てられたテナントエンドポイントとともに続き、サーバーのみのコールパスを視覚化しておきます。

テナント URLhttps://ytsave.app
認証X-API-Key: ys_live_…
クライアントプロファイルYTSaveClient
API バージョンv1
# Available only after support activation
export YTSAVE_API_KEY="issued-after-review"

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

Credential safety を説明するには、YTSave は、クライアントバンドルの埋め込みなしからサーバーサイドの秘密ストレージを分離します。証拠レコードは、公開ログやリポジトリなしに独自の場所を与えます。

02

リンクを解決する

YTSaveは、最初にソース検出を識別することで Resolve 操作を処理します。それは、1 つの提出された URL からのフォーマットで続き、発明された出力を見ることはありません。

ポスト/v1/resolve範囲:解決
フィールドタイプ必須説明
urlHTTPS URLはい分析する公開または認可されたメディアページ。
tenant文字列いいえ割り当てられたテナント ドメイン 通常は省略されます。
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

フォーマット識別子を説明するには、YTSaveはリンクごとの利用可能性から返された値を変更せずに分離します。証拠レコードは、推測された品質ラベルがない独自の場所を与えます。

03

ダウンロードジョブを作成して追跡する

ジョブ作成の場合、YTSave は非同期準備から始まり、その証拠レコードは短い HTTP 要求とペアを組み、境界付きワーカー実行で終了します。

ポスト/v1/jobs範囲:仕事
フィールドタイプ必須説明
urlHTTPS URLはい解決するために提出された同じ正規化されたソース。
format_id文字列はい解決応答からの正確な ID。
tenant文字列いいえ割り当てられたテナント ドメイン 通常は省略されます。
curl -X POST https://ytsave.app/v1/jobs \
  -H "X-API-Key: $YTSAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=VIDEO_ID","format_id":"18"}'
1202 受理保存 job_id.
2投票状況GET /v1/jobs/{job_id} 同じ鍵で
3準備完了署名されたダウンロードURLを開きます。
ステータス意味クライアントアクション
queued制限付きキューに受け入れられました。バックオフで再度ポールします。
extractingソースメタデータまたはルートを更新しています。投票を続けてください。
processingダウンロード、リマスタリングまたはマージ。サーバー処理の進行状況を表示します。
ready署名付きダウンロードが利用可能です。URL をユーザーに送信します。
failedターミナル構造化エラー。読み込み error_code. 勧められた場合のみ再試行してください。
expired一時的な出力は削除された。新しいジョブを作成します。
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave は Job ポリングをスキャンしやすくします。ページは 1 秒の初期待ち時間で開始し、キャップドバックオフに移動し、一時的に署名されたデリバリーを明確に記載します。

04

予測可能な誤り

対する Error 契約は、YTSave はサポートリクエスト ID の前に 1 つの非 2xx 封筒をチェックします。この証拠記録は、予測可能なクライアントの取り扱いも明確にします。

{
  "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": "…"
}
超高速トランザクション処理典型的な意味アクション
400無効な URL、本体または利用できないフォーマット。リクエストを修正します。フォーマットについて再度解決します。
401欠落、無効、有効期限切れ、またはスコープの間違ったキー。サーバ側の認証情報を確認します。
403テナントまたはソースポリシーが要求を拒否しました。ポリシーをバイパスしないでください サポートに連絡してください。
404未知または期限切れのジョブ。適切な場合は新しいジョブを作成します。
429リクエストまたはアクティブジョブの制限に達しました。栄誉 retry_after_seconds.
503キュー/容量または上流が一時的に利用できません。指数関数的なバックオフとジッターで再試行します。
05

運用契約

YTSave は、API 消費者とアップストリーム メディア サービスを守るために、各承認で操作クォータを発行します。

YTSave は、探索の前に最初にアクティベーションを識別することで、Schema アクセスを処理します。割り当てられた認証とともに続き、文書化されたリクエスト形状を視覚化しておきます。 OpenAPI 参考文献

オペレータ監視アクセス

API キーを要求する

API 消費者、その月ごとのリクエストの推定値、およびサポートされているプラットフォームの要件を文書化します。YTSave は、一度の可視キーを発行する前に、解決、ジョブ提出、または両方が正当化されているかどうかをレビューします。

API アクセスを要求する キーはテナントスコープであり、撤回可能であり、コンタクトフォームを通じて発行されます。 匿名スクリプトはダウンロードアーの作業を実行できません。