# OTTプラットフォーム向けREST API | カタログを自動化 | Vodlix **Source:** https://vodlix.com/ja/features/restful-api **Summary:** ストリーミングプラットフォームをコードで操作。動画、シリーズ、ライブチャンネル、アートワーク、コンテンツリストを、管理画面の機能を網羅するAPIで管理できます。 **Publisher:** Vodlix --- ## RESTful API 強力で安全なREST APIで、すばやい連携、プロセスの自動化、ワークフローの効率化を実現します。 - **Feature Plan:** 2 - core-platform - back-end 管理画面と同じ構成のREST APIで、カタログ、アートワーク、ライブチャンネル、マーチャンダイジング、レポートを操作できます。 ノートパソコンに表示されたプラットフォームAPIドキュメントの「Add New Video」呼び出しと、同じタイトルを開いたスマートフォンアプリ 「Update Content Thumbs」のAPIドキュメント。画像URLからタイトルの縦長・横長・ロゴのアートワークを設定します ### APIによるアートワークとライブチャンネル Vodlix APIでは、アートワークは手動でアップロードするのではなくURLで設定します。1回の呼び出しでタイトルの縦長・横長・ロゴ画像を設定し、別の呼び出しで生成されたフレームのどれをサムネイルにするかを選びます。ライブチャンネルも動画と同じように扱えます。ストリームURLから作成し、更新、公開・非公開、ゴミ箱への移動・復元ができるため、リニアコンテンツもオンデマンドと同じように自動化できます。大規模なカタログや頻繁に変わるカタログでも、誰かがファイルを1つずつアップロードすることなくアートワークの一貫性を保てます。 #### REST API 使い慣れた、予測しやすい設計。 #### 管理画面と同じ構成 UIを知っていれば、APIもわかります。 #### ライフサイクル全体 作成、公開、非公開、復元。 「Upload with URL」のAPIドキュメント。公開ストレージ、S3、Wasabi上のファイルURLから動画を取り込みます ### カタログをプログラムで管理 Vodlix REST APIを使えば、管理画面と同じようにカタログをプログラムで操作できます。動画の作成、更新、公開・非公開、ゴミ箱への移動・復元が可能です。シリーズとシーズンも同じように作成、更新、公開でき、エピソードはシーズンへの紐付けや紐付け解除ができます。新しい動画は、公開URLまたは自社のS3やWasabiストレージ上のファイルURLをプラットフォームに渡すだけで取り込まれます。プラットフォームがファイルを取得してバックグラウンドで処理し、追跡用の動画IDを返します。既存のシステムを持つOTT運営事業者は、カタログ管理を手作業ではなく自動化できます。 「Top 10」と「Rent the Latest」の行があるストアフロントのホームページ。API呼び出しでオン・オフできるコンテンツリストです ### API制御によるマーチャンダイジングとコンテンツリスト Vodlix APIでマーチャンダイジングを制御できます。コンテンツリスト、リストグループ、その項目と並び順はすべてプログラムで作成・管理できます。リストは有効化・無効化できるため、季節限定の行は作り直すことなくAPI呼び出しでオフにできます。これにより、編成システムやコンテンツ企画ツールがホームページを自動で構成できます。編集ワークフローの規模拡大を可能にするのが、APIで制御するマーチャンダイジングです。 - mx-auto プラットフォーム情報、コンテンツ数とユーザー数、カタログ閲覧、売上サマリーを一覧表示したMCP Accessのツール表 ### リファレンスとレポートのエンドポイント Vodlix APIはリファレンスとレポートの呼び出しを提供します。カテゴリID、カタログ数とユーザー数、任意の期間の売上サマリー、ソフトウェアバージョンなどのプラットフォーム情報です。連携システムは常に操作対象を把握し、プラットフォームの変更にも対応できます。アクセスには管理画面で作成するAPIキーを使用します。バックエンド処理用のサーバーキーと、ブラウザのコード用のクライアントキーがあり、クライアントキーは管理用ルートに一切アクセスできません。同じ呼び出しは、プラットフォームのMCPコネクタを通じてAIアシスタントにも公開されています。 ### 特に効果を発揮する場面 主な用途は、移行、取り込み、レポートです。他のプラットフォームからのカタログ移行は手作業ではなくAPIの仕事になり、それが誰も待たずに済むローンチと、何か月もかかるローンチとの違いを生みます。配給会社や制作ワークフローからの定期的な取り込みは、一度書けば無人で実行されます。レポートは、毎週月曜日に誰かに画面をエクスポートしてもらう代わりに、財務チームがすでに使っているツールへ数値を取り込みます。 APIはプラットフォームをビジネス全体ともつなぎます。新しいタイトルを公開と同時にCMSやマーケティングサイトへ送ったり、[コンテンツリスト](/ja/features/content-lists)をレコメンドサービスに渡して結果を書き戻したりできます。API単体では足りない連携が必要な場合は、[カスタムプラグインサービス](/ja/services/custom-plugin)が同じプラットフォーム上で不足部分を開発します。 クラウドに統計サービスが設定されている場合、API経由で分析データを利用できます。後から気づくのではなく、セットアップ時に確認しておくことをおすすめします。計測される内容については[レポートと分析](/ja/features/reports-and-analytics)のページをご覧ください。 **Q: Vodlix REST APIでは何を制御できますか？** Vodlix REST APIは、動画、シリーズ、シーズン、エピソードを含むカタログに加え、アートワーク、ライブチャンネル、コンテンツリストとマーチャンダイジング、リファレンスとレポートのデータを制御します。 **Q: 動画ファイルはVodlix API経由でアップロードするのですか？** 新しい動画は、公開HTTPS URLを指定するだけでVodlix API経由で取り込まれます。Vodlixがファイルを取得してトランスコードするため、自社のインフラ経由でバイナリをアップロードする必要はありません。 **Q: Vodlix APIは管理画面と対応していますか？** はい。Vodlix REST APIは管理画面と同じ構成で、なじみのあるREST規約と予測しやすいレスポンスを備えているため、UIを知っている人ならAPIで何ができるかおおよそわかります。 **Q: Vodlix APIでコンテンツリストを管理できますか？** はい。Vodlixのコンテンツリスト、リストグループ、その項目と並び順は、すべてAPIで作成、更新、有効化、無効化できるため、マーチャンダイジングを自動化できます。 **Q: Vodlix APIはどのようなレポートデータを提供しますか？** Vodlix APIは、カタログ数とユーザー数、指定期間の売上サマリー、カテゴリID、ソフトウェアバージョンなどのプラットフォーム情報を提供するため、連携システムは常に操作対象を把握できます。 **Q: カテゴリIDはすべてのVodlixクラウドで共通ですか？** いいえ。これは最もよくある間違いです。カテゴリはクラウドごとに異なるため、作業対象のプラットフォームのカテゴリ一覧を読み取り、名前がどこでも同じ番号に対応すると想定せずに、返されたIDを使用してください。 **Q: API経由で分析データを取得できますか？** クラウドに統計サービスが設定されていれば可能です。主要な数値、リアルタイムのアクティビティ、パフォーマンスの高いコンテンツを確認できます。カタログ操作とは別にプロビジョニングされるため、セットアップ時に確認しておくことをおすすめします。 **Q: 他のプラットフォームからの移行にAPIは役立ちますか？** 運営事業者がAPIを利用する最も一般的な理由の一つです。カタログをプログラムで移行すれば、移行作業は何か月もの手入力ではなく繰り返し実行できる処理になり、移行中に変更された内容を取り込むために再実行することもできます。 **Q: 連携システムはVodlix APIでどのように認証しますか？** 管理画面の「Apps & APIs」で作成したAPIキーを、X-Api-Keyヘッダーで送信します。サーバーキーは所有ユーザーの権限で動作し、管理用ルートにもアクセスできるため、バックエンドで使用してください。クライアントキーはブラウザのコードで安全に使用でき、すべての管理用ルートへのアクセスがブロックされます。キーには有効期限を設定でき、キーを削除すると即座に無効になります。