Templates の一覧を取得する
認証済みの Workspace で利用可能な Templates を一覧表示します。
https://api2.transloadit.com/ templates現行の Builtin カタログには include_builtin=exclusively-latest を、すべてのバージョンには
exclusively-all を使用してください。各 Builtin には、name、builtin_version、description、および実行時のフィールドバリデーターから生成された単独で利用できる
draft-07 JSON Schema である fields_schema が含まれます。summary を持つ Builtins は、ツール一覧に適した、それだけで内容が完結する 1 つの段落で処理結果を説明します。Assembly を作成する際は、バージョン付きの id を template_id として渡してください。
content.fields のデフォルト値と指定したフィールドをマージした後、実際に適用されるフィールドを検証してください。fields_schema: null は、従来の Builtin にフィールドバリデーターが宣言されていないことを意味します。Workspace の
Templates では、このプロパティを省略します。x-transloadit-input-fidelity: conservative アノテーションは、JSON Schema では近似的にしか表現できない制約を示します。最終的な判断基準は、引き続き実行時の検証です。
リクエスト例
解約済みの Workspaces では、新しい Bearer トークンを作成できません。既存の有効な Auth Key を使用すれば、このエンドポイントは引き続き利用できます。以下のトークン設定ではなく、署名付き読み取りの手順を使用してください。このキーには、このエンドポイントで必要なスコープが付与されている必要があります。
curl が利用でき、適切な Bearer トークンが TRANSLOADIT_TOKEN に設定されているサーバー側のシェルで、このリクエストを実行してください。トークンが必要な場合は、以下の設定手順を展開してください。
Bearer トークンが必要ですか?
curl と jq が利用できる信頼できるサーバー側のシェルで、TRANSLOADIT_KEY と TRANSLOADIT_SECRET に、それぞれ Auth Key と Auth Secret を設定してください。両方の認証情報と生成されたトークンは秘密にし、この設定手順をブラウザーコードで実行することは決してしないでください。
まず、このエンドポイントで必要なスコープを持つトークンを作成してください。Auth Key には、それらのスコープがあらかじめ付与されている必要があります。
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=templates:read')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
このシェルを開いたままにして、以下のリクエストを実行してください。トークンが有効な間は再利用してください。
curl --fail-with-body -sS --request GET --get \
--url "https://api2.transloadit.com/templates" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: templates:read。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
クエリパラメーター
params(JSON 文字列)。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
署名対象の params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | Template リクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | stringWorkspace Templates の作成日時の下限を UTC で指定します。この日時以降に作成された Workspace Templates のみが返されます。Builtin Templates は作成日でフィルタリングされません。 |
params. | "all" | "exclusively-all" | "exclusively-latest" | "latest" | "none" (デフォルト: "none")Builtin Templates を含めるかどうかを制御します。 |
params. | string | Array<string> (デフォルト: "")Workspace の Template 名を、前後を 次のいずれかのスキーマが適用される場合があります: stringArray<string>Array<string>配列要素のスキーマstring |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | "asc" | "desc" (デフォルト: "desc")Workspace の Templates のソート方向を指定します。Builtin Template の並び順は変更しません。デフォルトは |
params. | integer (デフォルト: 1, 最小値: 1, 最大値: 9007199254740991)現在のページネーションにおける現在のページを指定します。デフォルトは |
params. | integer (デフォルト: 850, 最小値: 1, 最大値: 850)API リクエストごとに返す Templates の数を指定します。デフォルトは |
params. | "created" | "id" | "last_used" | "modified" | "name" (デフォルト: "created")Workspace の Templates の並べ替えに使用するフィールドを指定します。Builtin Template の並び順は変更しません。デフォルトは |
params. | stringWorkspace Templates の作成日時(UTC)の上限を指定します。この日時以前に作成された Workspace Templates のみが返されます。Builtin Templates は作成日によるフィルタリングの対象にはなりません。 |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.fromdate, params.include_builtin, params.keywords, params.nonce, params.order, params.page, params.pagesize, params.sort, params.todate
| フィールド | 型と説明 |
|---|---|
params. | Template リクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
count必須 | integer (最小値: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
items必須 | Array<object>配列要素のスキーマ
|
エラーレスポンス
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id | string |
error | string (最小長: 1) |
http_code | number | string
|
message | string人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は |
reason | null | string | number | boolean | Array<任意の値> | object次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |
HTTP 400
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "TEMPLATE_LIST_ERROR"
パラメーターが不正です。
レスポンスには追加のフィールドが含まれる場合があります。