Template を取得する
ID または名前で指定した Template を返します。
https://api2.transloadit.com/ templates/ {templateIdOrName}TEMPLATE_ID_OR_NAME に Workspace の Template の ID または名前を設定してください。
Builtin Template の場合は、識別子内の区切り文字 / と @ をそのまま保持してください。以下のリクエスト例を実行する前に、次の代入のいずれかを使用してください。
TEMPLATE_ID_OR_NAME='builtin/encode-hls-video@0.0.1'は、その特定のバージョンを選択します。TEMPLATE_ID_OR_NAME='builtin/encode-hls-video@latest'は、最新バージョンを選択します。TEMPLATE_ID_OR_NAME='builtin/encode-hls-video'も、最新バージョンを選択します。
これらの区切り文字を %2F や %40 にエンコードしないでください。以下の正規パスの制約は Workspace の Templates に適用されます。Builtin Templates は、ここに示す追加のスラッシュを含むパスを使用します。バージョン付き ID は、Templates を一覧表示 で include_builtin を使用して確認できます。
リクエスト例
リソースの値をパーセントエンコードせずに TEMPLATE_ID_OR_NAME に設定してください。
キャンセルされた 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/${TEMPLATE_ID_OR_NAME:?Set TEMPLATE_ID_OR_NAME}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: templates:read。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
パスパラメーター
templateIdOrName(パスセグメント)、必須。パターン:^[a-z0-9-]+$, 最小長: 1
クエリパラメーター
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. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.nonce
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.nonce
| フィールド | 型と説明 |
|---|---|
params. | Template リクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"assembly_status_expiry": null,
"content": {
"steps": {
"resize": {
"robot": "/image/resize",
"use": ":original",
"width": 320
}
}
},
"id": "8fc3b9166c784afd824acf24269ebd11",
"message": "Your Template was successfully found.",
"name": "resize-images",
"ok": "TEMPLATE_FOUND",
"require_signature_auth": 0,
"transcoding_result_expiry": null
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 |
|---|---|
assembly_status_expiry必須 | null | string |
content必須 | object | Array<任意の値> | string | number | boolean | null次のいずれかのスキーマが適用される場合があります: objectobject追加プロパティのスキーマ任意の値Array<任意の値>Array<任意の値>配列要素のスキーマ任意の値stringnumberbooleannull |
cron_auth_key_id | string | null検証パターン(正規表現)^[a-f0-9]{32}$ |
cron_enabled | boolean |
cron_max_concurrent_runs | integer (最小値: 1, 最大値: 10) |
cron_region | "ap-southeast-1" | "eu-west-1" | "us-east-1" | null |
cron_schedule_with_seconds | string | null (最小長: 1, 最大長: 255) |
id必須 | string次のいずれかのスキーマが適用される場合があります: バリアント 1: string (最大長: 32)string検証パターン(正規表現)^[\x00-\x7F]*$バリアント 2: string (最大長: 32)string検証パターン(正規表現)^builtin\/[a-z0-9-]+(?:@[0-9a-z.-]+)?$ |
message必須 | string (最小長: 1) |
name必須 | string (最小長: 1, 最大長: 255) |
ok必須 | string (常に: "TEMPLATE_FOUND") |
require_signature_auth必須 | 0 | 1 |
transcoding_result_expiry必須 | null | string |
エラーレスポンス
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: "SIGNATURE_REUSE_DETECTED"
セキュリティ上の理由により、リクエストが拒否されました。これが誤りだと思われる場合は、サポートにお問い合わせください。
レスポンスには追加のフィールドが含まれる場合があります。