はじめてのアプリ
Transloadit は汎用性が高く、API の活用方法もさまざまです。ここではデモ用のわかりやすい構成として、Uppy の Transloadit Plugin を使い、Web ブラウザーと連携します。
画像をアップロードし、1500x500 ピクセルにリサイズするシンプルな Web ページを作成します。最初の Template で使う処理用 Robot は 1 つなので、ストレージや大規模なワークフローを設定する前に、結果を確認できます。
はじめての Template
ワークスペースで 新しい Template を作成し、my-first-template という名前を付けて、次の Assembly Instructions を保存してください。
{
":original": {
"robot": "/upload/handle"
},
"crop_thumbed": {
"use": ":original",
"robot": "/image/resize",
"result": true,
"width": 1500,
"height": 500,
"resize_strategy": "fillcrop"
}
}
Assembly Instructions の解説
この JSON には 2 つの Step があります。詳しく見ていきましょう。
:originalは 🤖/upload/handle を呼び出します。この Robot は Uppy から送られるすべてのファイルを受け取り、ほかの Robot で利用できるようにします。この Robot では、ファイルサイズの上限などを設定できます。crop_thumbedは"use": ":original"を通じてこれらのファイルを受け取ります。続いて、resize_strategyなどのパラメーターを指定して 🤖/image/resize を呼び出します。これが、この Template で唯一の処理用 Robot です。
結果ファイルは当社で一時的にホストし、24 時間後に削除します。これにより、最初の例では 1 つの変換に集中できます。次のガイドでは、永続ストレージを追加します。
Uppy 連携のコードでは、YOUR_TEMPLATE_ID を作成した Template の ID に置き換えてください。次のコードを test.html ファイルに追加し、ブラウザーで開いてください。
<!-- This pulls Uppy from our CDN -->
<!-- For smaller self-hosted bundles, install Uppy and plugins manually: -->
<!-- npm i @uppy/core @uppy/dashboard @uppy/remote-sources @uppy/transloadit ... -->
<link
href="https://releases.transloadit.com/uppy/v6.0.6/uppy.min.css"
rel="stylesheet"
/>
<button id="browse">Select Files</button>
<script type="module">
import {
Uppy,
Dashboard,
ImageEditor,
RemoteSources,
Transloadit,
} from 'https://releases.transloadit.com/uppy/v6.0.6/uppy.min.mjs'
const uppy = new Uppy()
.use(Transloadit, {
waitForEncoding: true,
alwaysRunAssembly: true,
assemblyOptions: {
params: {
template_id: 'YOUR_TEMPLATE_ID',
// To avoid tampering, use Signature Authentication:
// https://transloadit.com/docs/api/authentication/
auth: {
key: 'YOUR_TRANSLOADIT_KEY',
},
},
},
})
.use(Dashboard, { trigger: '#browse' })
.use(ImageEditor, { target: Dashboard })
.use(RemoteSources, {
companionUrl: 'https://api2.transloadit.com/companion',
})
.on('complete', ({ transloadit }) => {
// Due to waitForEncoding:true this is fired after encoding is done.
// Alternatively, set waitForEncoding to false and provide a notify_url
console.log(transloadit) // Array of Assembly Statuses
transloadit.forEach((assembly) => {
console.log(assembly.results) // Array of all encoding results
})
})
.on('error', (error) => {
console.error(error)
})
</script>
YOUR_TEMPLATE_ID に加えて、YOUR_TRANSLOADIT_KEY も置き換える必要があります。この値は、アカウントで Auth Key を作成すると取得できます。
これで完成です!✨ ここまでコードをコピーして貼り付け、必要な値を置き換えていれば、動作するプロトタイプができているはずです。結果はブラウザーのコンソールログに出力されますが、アカウントに追加される Assembly もリアルタイムで確認できます。コードを入力していなくても、こちらの画像リサイズのデモ (English)で実際に試せます。
一時的な結果 URL はコンソールログに表示されます。ファイルを永続的に保存し、結果をバックエンドに送信するには、処理結果ファイルの保存ページに進んでください。