Transloadit REST API とは
Transloadit REST API は、Assemblies と、Templates、Template 認証情報、キュー情報、請求データ、認証トークンなどの関連リソースを作成および管理するための HTTP(S) インターフェースです。互換性のあるあらゆる言語やプラットフォームから、直接、または Transloadit SDK を通じて呼び出すことができます。
Transloadit REST API の仕組み
HTTP クライアントは、構造化された処理設定と認証データをサービスのエンドポイントに送信して Assembly を作成し、返された Assembly Status と識別子を読み取ります。このインターフェースは、言語固有のランタイムを要求するのではなく、標準的なリクエストとリソース表現を通じてリソースを公開します。処理は非同期のため、呼び出し元は作成時のレスポンスとポーリングまたは Notification を組み合わせることがよくあります。アプリケーションコードと Transloadit のメディア処理インフラストラクチャの境界に位置する仕組みです。
要点
- REST を直接統合する場合、再試行ポリシー、タイムアウト、レスポンスの検証、マルチパートの構築はアプリケーション側で管理します。SDK は、こうした詳細の多くをカプセル化できます。
- Assembly の作成では、アップロードするファイルと JSON の処理設定を一つのマルチパートリクエストに含められます。一方、インポートする入力は、代わりに処理の各段階から参照できます。
- HTTP リクエストが受理されただけでは、メディア処理のすべての段階が成功したとは限りません。クライアントは、出力を完成したものとして扱う前に、Assembly と結果の状態を確認する必要があります。
Transloadit REST API が役立つ場面
アプリケーションでリクエストの構築を直接制御する必要がある場合や、適切な SDK がない場合は、REST API を使用します。リクエストの実装では、認証、シリアライズ、ネットワークエラー、API レスポンスを正しく処理する必要があります。