fvLIBRARY API

ここでは、fvLIBRARY API ( 以降 API ) について記述しています。
API は、主に次の 3 タイプのもので構成されます。
  1. 動画登録 API
  2. fv生成要求 API
  3. メディア管理 API
各タイプはそれぞれ Web用API ( REST API ) として提供されます。

なお、本ドキュメントはライト・スタンダードプラン向けの内容で記述されています。プランによるAPI仕様の違いについては、プランによるAPI仕様相違点 を参照してください。

API基本制限

タイルの生成 API では、動画を登録すると 1 秒〜900 秒(15分)までの整数秒で、指定したタイルを生成します。
メディアのデータ Gnzoでは生成したタイル、メディアのメタデータのみを保持します。
fabric videoの最大サイズ fabric video はタイル種別が同じものであれば自由に結合できますが、 生成できる最大のサイズ(タイルの個数)に制限を設けています。
APIの認証について 各 API を呼出す際に、サーバー側で認証を行っています。
動画投稿のファイルフォーマット 入力となるファイルフォーマットとビデオコーデックを記載しています。

API一覧

動画登録 API

Resource Description
POST /api/1/videos 動画を登録する。

fv生成要求 API

Resource Description
GET /api/1/videos/fv 指定順の fv を取得する。
GET /api/1/videos/fv/timeline タイムライン順の fv を取得する。
GET /api/1/videos/fv/random ランダム順の fv を取得する。
GET /api/1/videos/fv/search キーワード検索結果の fv を取得する。
GET /api/1/admin/fv 指定順の fv を取得する。(管理者用)

メディア管理 API

Resource Description
GET /api/1/videos/audiotag 音声タグ情報を取得する。
GET /api/1/videos/media メディア情報一覧を取得する。
GET /api/1/videos/{media_id}/info メディアのメタデータを取得する。 (Deprecated API)
GET /api/1/videos/info 複数メディアのメタデータを取得する。
POST /api/1/videos/{media_id}/info メディアのメタデータを更新する。
POST /api/1/videos/{media_id}/activate メディアを有効にする。(Deprecated API)
POST /api/1/videos/activate 複数メディアを有効にする。
POST /api/1/videos/{media_id}/deactivate メディアを無効にする。(Deprecated API)
POST /api/1/videos/deactivate 複数メディアを無効にする。
DELETE /api/1/videos/{media_id} メディアを削除する。(Deprecated API)
POST /api/1/videos/delete 複数メディアを削除する。
GET /api/1/videos/{media_id}/tile-status タイル生成状態を取得する。
GET /api/1/videos/tile タイル情報一覧を取得する。
GET /api/1/videos/search キーワード検索の結果を取得する。
GET /api/1/admin/bill_plan 契約情報を取得する。
POST /api/1/videos/{media_id}/cancel メディア登録処理をキャンセルする。

内容は 2017 年 07 月 31 日 時点のものです。今後サービスの向上などの理由により、内容が変更される場合があります。