Transloadit ドキュメント
このガイドでは、当社の API とプラットフォームの基本概念をわかりやすく解説します。さっそく始めましょう。
基本概念
- Robot は、ファイルに対して特定の操作を実行するツールです。たとえば、🤖/http/import Robot は任意の http URL からファイルをインポートし、🤖/s3/store Robot は Amazon S3 にファイルをエクスポートできます。また、🤖/video/encode Robot は動画のサイズ変更、変換、透かしの追加に対応しています。あらゆるファイル処理の要件に対応する 96 種類の Robot を提供しています。
- Template は、ファイルに実行する処理を定義する JSON ベースの設定です。この処理設定は、それぞれがいずれかの Robot を使用する Step で構成されます。Template は Transloadit アカウントに安全に保存されます。すぐに使い始められるよう、コピー&ペーストできるサンプルを多数用意しています。
- Assembly は、
template_idを参照する、https://api2.transloadit.com/assembliesへのPOSTAPI 呼び出しで開始される Template の実行です。Assembly にはアップロードと処理結果への参照が含まれます。Assembly の結果 JSON にアクセスすると、ファイルのメタデータと結果の URL をリアルタイムで取得し、ウェブサイトやアプリで利用できます。
クイックスタート
はじめてのアプリガイドに沿って進めることをお勧めします。API を使い始めるために必要な手順を紹介し、サンプルと解説を通じて基本概念を理解できます。
認証
API を安全に利用するため、すべてのリクエストで認証が必要です。ログイン後、最初の Workspace を作成すると API キーが自動生成されるため、すぐに Template の作成とテストを始められます。ただし、アプリを本番公開する準備ができたら、API 認証のページで、署名を使ってリクエストを適切に認可する方法を確認してください。
3 つの連携方法
- アップロード処理:ユーザーがブラウザーからファイルをアップロードまたはインポートする場合は、オープンソースのファイルアップローダー Uppyが連携に最適です。GitHub では 31,000 を超えるスターを獲得しており、世界で最も人気のあるファイルアップローダーです。
- Smart CDN:URL ベースの変換と配信には、当社の Smart CDNが最適な連携方法です。
- バッチ処理:大量のファイルの処理やモバイルアプリの開発に向けて、主要な言語とプラットフォーム用の SDK を提供しています。
バグの報告やフィードバックはありますか?
当社は常にプラットフォームの改善に取り組み、ユーザーからのフィードバックを大切にしています。バグを発見した場合や、ご質問、ご提案がある場合は、お気軽にお問い合わせください。
ファイル処理に Transloadit をご活用いただければ幸いです。