Transloadit を最大限活用する 5 つのヒント
Transloadit は、最初は少し理解しづらいと感じることがあります。機能やパラメーターの幅が広いため、どこから始めればよいのか、ましてワークフローをどう最適化すればよいのか迷いやすいからです。そこで、Transloadit を最大限活用するために実践できる 5 つのポイントをまとめました。

1. Template を使う
Assembly Instructions を統合コードの近くで管理したくなるかもしれません(そしてそれが妥当なユースケースであることも少なくありません)。それでも、Template の利用をおすすめします。
Template は暗号化され、当社のサーバーに安全に保存されます。そのため、Transloadit を呼び出す側では Template ID を参照することだけを気にすれば済みます。Assembly Instructions に、当社が連携するサードパーティーサービスの認証情報が含まれている場合でも、Template を使えば、悪意のあるユーザーにファイルストレージへのアクセス権を取得される不安を軽減できます。
また、これによって Assembly にデータを渡しにくくなったり、Template の動作をその場で変更しにくくなったりするのでは、と心配する必要はありません。実際には、Template 内の任意のパラメーターを上書きできます。変更する Step とパラメーターの JSON を、steps プロパティの一部として含めるだけです。
Template への切り替えはこちらから行えます。
2. 非同期を使う
まれに、当社側でエンコードキューが発生することがあります。その影響をエンドユーザーに直接受けさせたくはありません。ユーザーが最も望まないのは待たされることです。そこで、Transloadit を非同期で利用する選択肢を用意しています。
notify_url パラメーターに URL を指定すると、Assembly の完了直後に POST リクエストを送信します。SDK はエンコード完了を待たないように設定し、ファイルのアップロードが終わった時点でユーザーが先に進めるようにしてください。
何らかの理由でバックエンドがそのリクエストを処理できない場合は、サーバーがオンラインに戻って処理できるようになるまで、通知の送信を最大 5 回まで再試行します。
実装全体については、結果を処理する前に通知の署名を検証する方法も含めて、webhook ガイドを参照してください。
3. 請求上限を設定する
特に指定がない限り、Transloadit は常にサービス提供を継続します。エンコードジョブによって、プランに含まれる月間 GB 枠を超えた場合でも同様です。特に忙しい日に突然サービスが止まり、ユーザーに影響が出ることは避けたいと考えているからです。
その一方で、すべてのプログラマーが知っているとおり、ソフトウェアにはバグがあります。そして、そうしたバグによって、たとえば Assembly が必要以上に何度も実行され、アカウントに不要なコストが発生することもあります。
こうした事態を防ぐため、アカウントに請求上限を設定することをおすすめします。想定利用量は十分カバーしつつ、意図しない超過は防げる水準に設定してください。
請求上限は、アカウントの請求セクションに移動し、「請求上限を設定」ボタンをクリックすると設定できます。
4. リクエストを保護する
Uppy を使っている場合、auth_key が Web サイトのソースコードに含まれることがあります。Web サイトのソースは、誰でも「Inspect Element」をクリックすれば確認できます。そのため理論上は、第三者が Transloadit アカウントから
Assembly を実行し、本来自分のものではない利用分の料金を発生させる可能性があります。
しかし、アカウントで
Signature Authenticationを有効にすれば保護できます。これにより、Transloadit に送る各リクエストごとに署名の生成が必要になります。署名はバックエンドで、auth_secret と、正確にシリアライズされた
params(auth_key と有効期限を含みます)を使って生成してください。Assembly を作成する際は、multipart の signature フィールドで
params と一緒に送信します。Auth Secret はサーバー上に保持してください。
例については、Signature Authentication ガイドを参照してください。
5. SDK を活用する
最後に紹介するのは、Transloadit を最大限活用するうえで非常に重要な手段の 1 つ、SDKの活用です。SDK には統合プロセスを効率化する機能が豊富に含まれていることが多く、その中にはここまでに紹介した機能もあります。
公式の統合の中に目的の SDK が見つからない場合でも、コミュニティーが構築・保守している統合がいくつもあります。こちら (English)も確認してみてください。
今回は以上です。質問がある場合や、自分なりのヒントやコツを共有したい場合は、Twitterから気軽にご連絡ください。
