マルチパートフォーム
この方式はもともと、ブラウザーで JavaScript を有効にしなくても使えるように開発しました。現在ではブラウザーで JavaScript が有効になっていることを前提にできるため、ブラウザーとの連携には Uppy を推奨します。
ただし、基本的な概念の説明や簡単なプロトタイプの作成、あるいは JavaScript が無効、またはクラッシュしたブラウザー向けのフォールバックを提供したい場合には、マルチパートの <form> だけで Transloadit を組み込めます。
ネイティブの HTML フォームではカスタム HTTP ヘッダーを設定できないため、この連携では Transloadit-Client を送信しません。同名の隠しフィールドを追加しても、ヘッダーは設定されません。SDK とプラグインのバージョンを自動識別する必要がある場合は、Uppy を使用してください。
インストール
インストールは不要です 👌
使い方
フォームの action 属性を "https://api2.transloadit.com/assemblies" に設定します。ファイルは、隠し params フィールド内の処理設定 とともに、当社の API に直接アップロードされます。
ブラウザーでの解析の問題を避けるため、処理設定はコンピューターで JSON エンコードし、その後、HTML エンティティをエスケープします。たとえば、< と " は、それぞれ
< と " に変換します。結果は人間には少し読みづらいので、無理に読もうとしなくても大丈夫です 😄
マルチパートフィールド内の JSON は URL エンコードしないでください。API はフィールド値として JSON を想定しています。以下の例では、署名のないテスト用の処理設定を使用しています。本番環境では、Signature Authentication を使用し、信頼できるサーバー上で params と署名を生成して、署名を別の隠し signature フィールドに含めてください。Auth Secret は決してフォームに含めないでください。
処理設定 内に
redirect_url を設定すると、すべての処理が完了した際に、指定した成功ページへブラウザーをリダイレクトするよう API に指示できます。その URL には ?assembly_id=xyz&assembly_ssl_url=https://api2.transloadit.com/assemblies/xyz が追加されます。
成功ページを返す際に、バックエンドでこれらのクエリパラメーターを解析すると、Assembly Status JSON や、そこから参照されるエンコード結果のダウンロードなど、後続の処理を行えます。
成功ページはアップロードが完了するとすぐにブラウザーに返されるため、Assembly はまだ実行中の場合があります(大きな動画のエンコードなど)。バックエンドから assembly_ssl_url をポーリングするか、Assembly Notifications を設定し、notify_url を処理設定 に含める方法があります。後者の場合、その宛先に Assembly Status JSON を
POST するため、バックエンドで結果を処理できます。
例
<!--
We'll be inlining the following Assembly Instructions into a hidden params field,
escaping HTML entities such as <, a task best left to machines :)
{
"redirect_url": "https://example.com/success",
"auth": {
"key": "YOUR_TRANSLOADIT_KEY"
},
"template_id": "YOUR_TEMPLATE_ID",
"steps": {}
}
-->
<form
method="POST"
enctype="multipart/form-data"
action="https://api2.transloadit.com/assemblies"
>
<input
type="hidden"
name="params"
value="{"redirect_url":"https://example.com/success","auth":{"key":"YOUR_TRANSLOADIT_KEY"},"template_id":"YOUR_TEMPLATE_ID","steps":{}}"
/>
<input type="file" name="myfile_1" multiple="multiple" />
<input type="submit" value="Upload" />
</form>