API エンドポイント
主要なプログラミング言語やプラットフォームのほとんどに対応した、すぐに利用できる SDK を提供しており、通常はその利用をお勧めしています。ただし、用途に適した SDK がない場合や、SDK を開発している場合に向けて、ここでは基本的な REST API の詳細をすべて説明します。
Transloadit は、次の用途に使用できる JSON REST API を提供しています。
- Assemblies の作成、状況の確認、削除
- Assembly Notifications の再送
- Templates の作成、更新、状況の確認、削除
- 課金状況の確認
利用可能なエンドポイントの完全な一覧は以下のとおりです。
認証
- Bearer トークンを作成するPOST
/token - 新しい Auth Key を作成するPOST
/auth_keys - Auth Keys の一覧を取得するGET
/auth_keys - Auth Key のスコープを取得するGET
/auth_keys/scopes - Auth Key を編集するPUT
/auth_keys/{authKeyId} - Auth Key を削除するDELETE
/auth_keys/{authKeyId} - Auth Key のシークレットを取得するPOST
/auth_keys/show_secret/{authKeyId}
Assemblies
- 新しい Assembly を作成するPOST
/assemblies - Assembly Status を取得するGET
/assemblies/{assemblyId} - 指定された ID で Assembly を作成するPUT
/assemblies/{assemblyId} - Assembly の変更をリアルタイムでストリーミングするGET
{UPDATE_STREAM_URL} - 実行中の Assembly をキャンセルするDELETE
/assemblies/{assemblyId} - Assembly を再実行するPOST
/assemblies/{assemblyId}/replay - Assemblies の一覧を取得するGET
/assemblies - Assembly の統計情報を取得するGET
/assembly_stats
ウェブフック
- Assembly Notifications を取得するGET
/assembly_notifications/{assemblyId} - Assembly Notification を再送するPOST
/assembly_notifications/{assemblyId}/replay
請求
- 対象月の請求書を取得するGET
/bill/{billYearMonth}
キュー
- 現在使用中の Priority Job Slots を取得するGET
/queues/job_slots - Priority Job Slots の統計を取得するGET
/priority_job_slot_stats
再開可能なアップロード
- tus の機能を確認するOPTIONS
{TUS_URL} - tus アップロードを作成するPOST
{TUS_URL} - tus アップロードのオフセットを取得するHEAD
{UPLOAD_URL} - tus ファイルのバイト列をアップロードするPATCH
{UPLOAD_URL} - tus アップロードを終了するDELETE
{UPLOAD_URL} - tus アップロードをダウンロードするGET
{UPLOAD_URL}
Template 認証情報
- 新しい Template 認証情報を作成するPOST
/template_credentials - Template 認証情報を取得するGET
/template_credentials/{templateCredentialId} - Template 認証情報を編集するPUT
/template_credentials/{templateCredentialId} - Template 認証情報を削除するDELETE
/template_credentials/{templateCredentialId} - Template 認証情報の一覧を取得するGET
/template_credentials - Template 認証情報の種類を取得するGET
/template_credentials/types
Templates
- 新しい Template を作成するPOST
/templates - Template を取得するGET
/templates/{templateIdOrName} - Template を編集するPUT
/templates/{templateIdOrName} - Template を削除するDELETE
/templates/{templateIdOrName} - Templates の一覧を取得するGET
/templates - Cron Template の実行履歴を取得する alphaGET
/templates/{templateIdOrName}/cron-runs
デジタルアセット管理
- DAM アセットを移動するか、名前を変更する alphaPATCH
/dam/assets/{assetId} - DAM アセットを削除 alphaDELETE
/dam/assets/{assetId} - DAM アセットを一括移動する alphaPOST
/dam/assets/bulk/move - DAM アセットを一括削除する alphaPOST
/dam/assets/bulk/delete - ストレージ内のファイルまたはフォルダーを移動 alphaPOST
/dam/entries/move - ストレージ内のアセットを取得GET
/dam/assets/{assetId} - ストレージ内のアセットを一覧表示GET
/dam/assets