目次
概要
HTMLのformフィールドから直接、ミルビィへ動画を登録することができます。
登録時には各種メタデータの他、別途accesskeyの指定が必要です。
ブラウザ環境によって2種類の登録方法(Locationタイプ / AJAXタイプ)が選べます。
accesskeyの生成
accesskeyの文字列は以下の内容になります。
| 項目名 | 詳細 |
|---|---|
| accesskey | v1,(clientid),(id_user),(expire),(sign) |
| clientid | クライアントID |
| id_user | 登録を行うミルビィ上のユーザーのid_user |
| expire | accesskeyの有効期限です。UNIXタイムスタンプ形式(JST)で指定します。 |
| sign | (clientid)/(id_user)/(expire)/(secretkey) の文字列をSHA1関数に掛けたもの。 |
| secretkey | 事前に発行された署名用秘密キーで、契約書類のみに記載されております。外部に知られないように保持する必要があります。 |
サンプルコード(PHP)
$clientid = "demo";
$id_user = 1;
$expire = time() + (30 * 60);
$secretkey = "a7d2ef0a2f083a824b3b049b40b1231d045d9398";
$sign = sha1("{$clientid}/{$id_user}/{$expire}/{$secretkey}");
$accesskey = "v1,{$clientid},{$id_user},{$expire},{$sign}";
エラーコード
以下のエラーコードを返却する可能性があります。
レスポンス内容
| code要素 | 意味 |
|---|---|
| internalerror | nameを不適当な値で入力するなど、記載誤りによって発生している可能性があります。 |
| invalidoperation | 管理者(admin)ユーザーでAPIを実行している可能性があります。アップロードには一般ユーザーを使用してください。 |
登録方法
ダイレクトフォームアップロードはブラウザ環境によって2種類の登録方法(Locationタイプ / AJAXタイプ)が選べます。
Location タイプ
APIのURL例: https://ccs.miovp.com/create_video form
フィールドから動画を登録します。
アップロード後に、id_contentsを伴って画面遷移します。
基本HTML
<form method="post" action="https://ccs.miovp.com/create_video?return_url=https://XXXX.XX.XX/XXXX" enctype="multipart/form-data">
<input type="file" name="file"> <input type="submit" value="アップロード">
</form>
上記HTMLを基本に、リクエスト時にクエリーをフォームフィールドに付与します。 ※return_urlはクエリーと合わせて変更してください。
AJAX タイプ
APIのURL: https://ccs.miovp.com/create_video
formフィールドから動画を登録します。
“XMLHttpRequest level2”でのご利用を想定しており、APIのレスポンスを直接受け取る事ができます。
基本HTML
<form method="post" action="https://ccs.miovp.com/create_video" enctype="multipart/form-data">
<input type="file" name="file" />
<input type="button" value="アップロード" />
</form>
上記HTMLを基本に、リクエスト時にクエリーをフォームフィールドに付与します。
注意事項
クエリーはLocationタイプの”return_url”を外してご使用ください。 ”return_url”を指定しないことで、AJAXタイプとなります。 レスポンスはデフォルトでJSON形式で出力されます。 (クエリーにxml=1を指定することでXML形式での出力も可能です。)
| 項目名 | 値 |
|---|---|
| status | 成功時true、失敗時false |
| id_contents | コンテンツID |
※AJAXタイプは対応ブラウザからのみ利用可能です。
利用するWebAPI
ダイレクトフォームアップロードでは、動画・画像の登録が可能です。 それぞれ以下のWebAPIをご利用ください。
| 登録するコンテンツ | API |
|---|---|
| 動画 | create_video |
| 画像 | create_image |