動画のアップロードを行うAPIです。アップロード時のメタ情報も設定可能です。
■設定情報
■APIリンク書式
https://file-platform.stream.co.jp/writeapi/upload/[アップロードキー]
■プロトコル
https (UTF-8)
(POST：multipart/form-data)
■引数
| 項目名 | 必須 | 説明 | デフォルト値 | フォーマット |
| movie | ○ | 動画ファイル | --- | フルパス形式 縦の動画サイズ240以上 |
| thumb | --- | サムネイルファイル | 自動生成サムネイル（50％） | フルパス形式、2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| title | --- | 動画のタイトル | 動画ファイル名 | 全角半角、255文字 |
| description | --- | 説明文 | 空白 | 全角半角、1000文字 |
| keywords | --- | キーワード | 空白 | 全角半角、1000文字 |
| copyright | --- | 権利者情報 | 空白 | 全角半角、1000文字 |
| copyright_url | --- | 権利者情報に付けるリンクＵＲＬ | 空白 | URL形式、全角半角、1000文字 |
| optional_id | --- | 任意ID | 空白 | 半角英数, -, _ 64桁まで |
| publication_date | --- | 公開期限-開始日 | 期限なし | [yyyy-mm-dd] / [yyyy/mm/dd] [yyyy-mm-dd hh:mm] [yyyy/mm/dd hh:mm] |
| expiration_date | --- | 公開期限-終了日 | 期限なし | [yyyy-mm-dd] / [yyyy/mm/dd] [yyyy-mm-dd hh:mm] [yyyy/mm/dd hh:mm] |
| api_keywords | --- | APIリファレンスコード | 空白 | 全角半角、150文字 |
| active_flg | --- | 動画公開フラグ | 1 | [1] / [0] |
| security_id※１ | --- | 紐づける視聴制限プロファイルID | 空白 | 半角数 |
| use_exlink | --- | 関連ページリンク使用可否 | 使用する | [1] / [0] |
| exlink1_txt※２ | --- | 関連ページリンク（１）リンクテキスト | 空白 | 全角半角、100文字 |
| exlink1_url※２ | --- | 関連ページリンク（１）リンクＵＲＬ | 空白 | 全角半角、1000文字 |
| exlink2_txt※２ | --- | 関連ページリンク（２）リンクテキスト | 空白 | 全角半角、100文字 |
| exlink2_url※２ | --- | 関連ページリンク（２）リンクＵＲＬ | 空白 | 全角半角、1000文字 |
| exlink3_txt※２ | --- | 関連ページリンク（３）リンクリンクテキスト | 空白 | 全角半角、100文字 |
| exlink3_url※２ | --- | 関連ページリンク（３）リンクＵＲＬ | 空白 | 全角半角、1000文字 |
| custom_metadata1 | --- | カスタムメタデータの値（１） | 空白 | 全角半角、5000文字 |
| custom_metadata2 | --- | カスタムメタデータの値（２） | 空白 | 全角半角、5000文字 |
| custom_metadata3 | --- | カスタムメタデータの値（３） | 空白 | 全角半角、5000文字 |
| custom_metadata4 | --- | カスタムメタデータの値（４） | 空白 | 全角半角、5000文字 |
| custom_metadata5 | --- | カスタムメタデータの値（５） | 空白 | 全角半角、5000文字 |
| callback | --- | トランスコード完了時に通知されるCallback のURL |
空白 | 全角半角、500文字 |
| mail_to | --- | メールアドレス | --- | 半角、255文字 |
| mail_subject | --- | メール件名 | トランスコード終了 | 全角半角、255文字 |
| mail_body | --- | メール本文 |
トランスコード処理が完了しました。
|
全角、半角1000文字 ※以下の4項目は、パラメータを記載することで取得可能 ・動画ID：%eqMailMid% ・エラーコード：%eqErrorCode% ・URL：%movie_permalink% ・タイトル：%title% |
| mail_contenttype | --- | コンテンツタイプ | text/plain; charset=¥”utf8¥” | 半角、255文字 |
| transcode_id | --- | 紐付けるトランスコード設定ID | 1 | 半角数 |
| redirect_success | --- | 成功時にリダイレクトするURL | --- | 半角、255文字 |
| redirect_failure | --- | 失敗時にリダイレクトするURL | --- | 半角、255文字 |
|
user_id |
--- |
ユーザーID |
空白 |
半角数 |
|
group_id |
--- |
管理グループID |
空白 |
半角数;(区切りセミコロン) |
|
playlist_id |
--- |
プレイリストID |
空白 |
半角数、;(区切りセミコロン) |
|
meta_template_id |
--- |
メタデータテンプレートID |
空白 |
半角数 |
※１．再生ドメイン・IP視聴制限が有効となっており、視聴制限プロファイルが登録されている場合のみ設定可能
※２．関連ページリンク設定が有効となっている、または「use_exlink」を有効とする引数を同時に実行する場合のみ有効
また、「exlink○_txt」と「exlink○_url」は同一番号の引数がペアでなければ実行できません。
※３．『callback』には完了通知を行う顧客側の任意のURLを指定します。
※４．『callback』パラメータが指定された場合のみ、完了通知を行います。
※５．『callback』処理時にタイムアウト等、HTTPリクエストのエラーが発生した場合、リトライは1度のみ行います。
※タイムアウトとリトライの間隔は15秒です。
タイムアウト等のHTTPリクエストのエラーが2度以降発生した場合、callback通知失敗となります。
※ 6. 『mail_to』に、完了通知を行う任意のメールアドレスを指定します。
※ 7. トランスコード完了時(エラーを含む)に『mail_to』が指定されている場合のみ、 通知メールを送信します。
※ 8. メールアドレスを複数設定する場合は、セミコロンで区切ってください。
※ 9. 『mail_to』にメールアドレスが指定されていない場合、管理画面のユーザー操作ログにエラーログを表示します。
※10. [user_id]存在しないユーザーIDを指定してアップロードを行った場合はエラーとします。
※11. [group_id]存在しないグループIDを指定したもしくは権限の無いグループIDを指定してアップロードを行った場合はエラーとします。
※12. [playlist_id]存在しないプレイリストIDを指定したもしくは指定したグループに紐づかないプレイリストIDを指定してアップロードを行った場合はエラーとします。
※13. [meta_template_id]存在しないメタデータテンプレートIDを指定してアップロードを行った場合はエラーとします。
■戻り値
「認証API以外のレスポンス内容」を参照
■リダイレクト先のURLに付与されるパラメーター
| 項目名 | 説明 |
| code | エラーコード (エラーコード一覧)を参照 |
| message | エラーメッセージ、受付内容 |
※ 1. midは付与されません。
※ 2. 『redirect_success』『redirect_failure』パラメータ、どちらか片方だけ指定した場合、指定していないパラメータに関しては、リダイレクトを行いません。
※ 3. パラメーター指定の文字コードおよび、レスポンスの文字コードは『UTF-8』固定となります。
■『callback』URL内のコード記述例(PHP)
jsonをテキストファイルに書き出す場合のコード記述例(PHP)
|
<?php $json = $_POST['callback_json']; $fp = fopen("/～/○○.txt", "w"); fwrite($fp, $json); fclose($fp); ?> |
※POSTパラメータ名(要素名)は『callback_json』を指定して下さい。
■『callback』完了通知のjson仕様
| 項目値 | 項目値 | 項目説明 | 備考 |
| error_code | --- | エラーコード | WriteAPIのエラーコード表に準ずる |
| message | --- | エラーメッセージ | WriteAPIのエラーコード表に準ずる |
| cid | --- | 顧客ID | --- |
| mid | --- | 動画ID | --- |
| ofuscated_mid | --- | 難読化動画ID | --- |
| duration | --- | 動画の長さ | --- |
| movie_url |
lq,sq,hq,hd,fh |
動画の配信URL | 存在するもののみ返す
lq/低画質 sq/標準画質 hq/高画質 hd/HD fh/フルHD mb_lq/HLS低画質 mb_sq/HLS標準画質 mb_hq/HLS高画質 mb_hd/HLS_HD mb_fh/HLS_フルHD mb_auto/HLS自動画質 auto_pc/PC向け自動画質 auto_sp/スマホ向け自動画質 |
| download_url | --- | ダウンロードURL | --- |
| download_url_ssl | --- | ダウンロードURL(SSL) | --- |
| thumbnail_url | --- | サムネイルURL | --- |
| small_thumbnail_url | --- | 小サムネイルURL | --- |
| small_thumbnail_url_ssl | --- | 小サムネイルURL(SSL) | --- |
■『callback』完了通知のjson例テスト
|
{"error_code": 0, "message": "OK", "cid": 485, "mid": 1905, "obfuscated_mid": "MTkwNQ==", "duration": 202, "movie_url": {"fd": "rtmp//eqa000test.eq.fmsod.stream.ne.jp/eqa000test/_definst_/jmc_fms/00020/fa4deeb6f8584f43800a64654648967a_421.mp4", "hd": "rtmp//eqa000test.eq.fmsod.stream.ne.jp/eqa000test/_definst_/jmc_fms/00020/fa4deeb6f8584f43800a64654648967a_4.mp4", "hq": "rtmp//eqa000test.eq.fmsod.stream.ne.jp/eqa000test/_definst_/jmc_fms/00020/fa4deeb6f8584f43800a64654648967a_3.mp4", "sq": "rtmp//eqa000test.eq.fmsod.stream.ne.jp/eqa000test/_definst_/jmc_fms/00020/fa4deeb6f8584f43800a64654648967a_2.mp4" "lq": "rtmp//eqa000test.eq.fmsod.stream.ne.jp/eqa000test/_definst_/jmc_fms/00020/fa4deeb6f8584f43800a64654648967a_1.mp4", "mb_hq": "http//eqa000test.eq.webcdn.stream.ne.jp/www50/eqa000test/jmc_pub/jmc_pd/00020/fa4deeb6f8584f43800a64654648967a/fa4deeb6f8584f43800a64654648967a_422.m3u8", "mb_sq": "http//eqa000test.eq.webcdn.stream.ne.jp/www50/eqa000test/jmc_pub/jmc_pd/00020/fa4deeb6f8584f43800a64654648967a/fa4deeb6f8584f43800a64654648967a_6.m3u8", "mb_lq": "http//eqa000test.eq.webcdn.stream.ne.jp/www50/eqa000test/jmc_pub/jmc_pd/00020/fa4deeb6f8584f43800a64654648967a/fa4deeb6f8584f43800a64654648967a_5.m3u8"}, "download_url": "http://api01-platform.stream.co.jp/apiservice/redirectFileUrl/?cid=485&smid=73e0f7487b8e5297182c5a711d20bf26", "download_url_ssl": "https://api01-platform.stream.co.jp/apiservice/redirectFileUrl/?cid=485&smid=73e0f7487b8e5297182c5a711d20bf26", "thumbnail_url": "http://eqa000test.eq.webcdn.stream.ne.jp/www50/eqa000test/jmc_pub/thumbnail/00020/fa4deeb6f8584f43800a64654648967a_1639.jpg", "small_thumbnail_url": "http://eqa000test.eq.webcdn.stream.ne.jp/www50/eqa000test/jmc_pub/thumbnail/00020/fa4deeb6f8584f43800a64654648967a_1640.jpg", "thumbnail_url_ssl": "https://ssl-cache.stream.ne.jp/www50/eqa000test/jmc_pub/thumbnail/00020/fa4deeb6f8584f43800a64654648967a_1639.jpg", "small_thumbnail_url_ssl": "https://ssl-cache.stream.ne.jp/www50/eqa000test/jmc_pub/thumbnail/00020/fa4deeb6f8584f43800a64654648967a_1640.jpg", } |