Overview

最終更新日:2024-05-21 11:32:49

このドキュメントでは、新しいバージョンのCloud VoD APIの使用方法について詳しく説明します。新しいAPIはOpenAPIを介して呼び出され、簡単なテストとAPI呼び出しが可能です。OpenAPIは、入力に基づいてさまざまな言語でのサンプルコードを生成してリクエストを処理します。

旧バージョンのAPIを使用している場合も心配は不要です。旧版のCloud VoD APIも引き続きサポートされます。ただし、新規ユーザーは新しいバージョンを採用することを強くお勧めします。新しいAPIでは、API呼び出し中に発生する問題をより効果的に追跡および解決するため、各リクエスト/タスクに一意のIDを割り当てます。このIDは、レスポンスヘッダの “x-cnc-request-id” フィールドでクライアントに返されます。

重要:機能の継続的な更新により、APIのレスポンスに新しいJSONまたはXMLフィールドが追加される場合があります。開発者は、文字列の解析ではなく、JSONとXMLの標準に従ってこれらのフィールドを解析する必要があります。また、API呼び出しの頻度を顧客アカウントごとにデフォルトで5分間に300リクエストに制限しています。個々のAPIに対する推奨レートは、5分間に30回の呼び出しです。これらの制限を超える必要がある場合は、カスタマーサポートにお問い合わせください。

使用する前に

すべてのAPI呼び出しには認証が必要であり、リクエストにトークンを持っている必要があります。Cloud VoD APIを使用する前に、Cloud VoDサービスが有効になっていること、およびAPI認証用のAccessKey Secretを取得していることを確認してください。AccessKey IDおよびAccessKey Secretを取得するには、コンソールに移動してセキュリティ設定-> AccessKey管理->表示に移動します。これらの資格情報は、APIアクセスを認証するために使用されるので、AccessKey IDとAccessKey Secretを安全に保管してください。

API概要

アセットをアップロードする

API 説明
getUploadToken ビデオのアップロードトークンを取得する。
getAudioUploadToken オーディオのアップロードトークンを取得する。
getMaterialUploadToken 資材のアップロードトークンを取得する。
pullVideo このAPIは、URL経由でビデオを取得するために使用されます。このAPIを呼び出し、ビデオ取得パラメータを設定することで、Cloud VoDはURLからビデオをフェッチし、Cloud VoDに保存します。一括取得タスクがサポートされています。
pullVideoQuery ビデオ取得タスクの完了状況を確認する。
upload Cloud VoDにファイルをアップロードする場合、ファイルサイズが500MBを超える場合は、アップロード用のSDKを使用してください。

ビデオを管理する

API 説明
getVideoList アップロードされたビデオのリストと詳細(アップロード時間、ビデオ名、ビデオID、ビデオの状態など)を取得する。
videoEdit ビデオの基本情報(名前、説明、カテゴリ、公開ドメインなど)を編集する。
videoBlock アップロードされたビデオを無効にするまたはブロックする。無効にすると、ビデオは表示されなくなります。
videoEnable 以前に無効にされたビデオを再度有効にする。
deleteVideo アップロードされたビデオを削除する。

オーディオの管理

API 説明
getAudioList アップロードされたオーディオのリストと詳細(アップロード時間、名前、ID、状態など)を取得します。
editAudio オーディオの基本情報(名前、説明、カテゴリー、公開ドメインなど)を編集します。
deleteAudio アップロードされたオーディオを削除します。

マテリアルの管理

API 説明
getMaterialList アップロードされたマテリアルのリストとその詳細を取得します。
materialEdit マテリアルの基本情報を編集します。
deleteMaterial マテリアルを削除します。

カテゴリの管理

API 説明
createCategory カテゴリを作成します。
deleteCategory カテゴリを削除します。
deleteVideoByCategory カテゴリに基づいてビデオを削除します。
getCategoryList カテゴリのリストを取得します。

ビデオ処理

API 説明
transCode 特定のビデオをトランスコードします。
startWorkflow 特定のビデオに対してワークフロー操作を実行します。主にビデオ情報の一括編集に使用されます。
videoClip アップロードされたビデオをクリップします。
videoClipQuery クリッピングタスクのステータスと結果を確認します。
videoConcat 指定された順序で複数のビデオを連結して新しいものを作成します。
videoConcatQuery ビデオ連結タスクのステータスと結果を確認します。
createClearAdTask 特定のビデオのためのAI広告削除タスクを作成します。システムは自動的にAIベースの広告削除を行います(これは付加価値サービスであり、APIを使用する前にカスタマーサービスに連絡して有効にしてもらう必要があります)。
clearAdTaskQuery AI広告削除タスクのステータスと結果を確認します。

再生

API 説明
getPublishCode 異なる品質のビデオ再生用のURLを取得します。ユーザーはURLを通じて直接ビデオを視聴できます。