Template 認証情報を取得する
安定した ID に基づいて Template 認証情報を返します。
https://api2.transloadit.com/ template_credentials/ {templateCredentialId}既存の名前ベースの URL は、互換性のため引き続きサポートされます。新しい連携では安定した ID を使用し、名前の変更や曖昧な名前によって対象の認証情報が変わらないようにしてください。
リクエスト例
リソースの値をパーセントエンコードせずに TEMPLATE_CREDENTIAL_ID に設定してください。
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=template_credentials: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/template_credentials/${TEMPLATE_CREDENTIAL_ID:?Set TEMPLATE_CREDENTIAL_ID}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: template_credentials:read。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
パスパラメーター
templateCredentialId(パスセグメント)、必須。パターン:^[0-9a-f]{32}$, 最小長: 32, 最大長: 32
クエリパラメーター
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 キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"credential": {
"account_id": "72a70fba93ce41cba617cfd7c2a44b1a",
"content": {
"bucket": "your-bucket",
"bucket_region": "us-east-1",
"key": "YOUR_S3_KEY",
"secret": "YOUR_S3_SECRET"
},
"created": "2026-09-12T10:00:00.000Z",
"deleted": null,
"id": "ca7644b763c848e6af4f4ccf3eaea622",
"modified": "2026-09-12T10:00:00.000Z",
"name": "s3-production",
"stringified": "{\"key\":\"YOUR_S3_KEY\",\"secret\":\"YOUR_S3_SECRET\",\"bucket\":\"your-bucket\",\"bucket_region\":\"us-east-1\"}",
"type": "s3"
},
"message": "Your Template Credentials were successfully read.",
"ok": "TEMPLATE_CREDENTIALS_READ"
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
credential必須 |
|
credential.必須 | string |
credential.必須 | object | Array<任意の値> | string | number | boolean | null |
credential.必須 | number | string | null次のいずれかのスキーマが適用される場合があります: number | stringnumber | stringnull |
credential.必須 | number | string | null次のいずれかのスキーマが適用される場合があります: number | stringnumber | stringnull |
credential.必須 | string |
credential.必須 | number | string | null次のいずれかのスキーマが適用される場合があります: number | stringnumber | stringnull |
credential.必須 | string |
credential.必須 | string |
credential.必須 | string |
message必須 | string (最小長: 1) |
ok必須 | string (常に: "TEMPLATE_CREDENTIALS_READ") |
エラーレスポンス
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_CREDENTIALS_NOT_READ"
お使いの Template 認証情報を読み取れませんでした。
レスポンスには追加のフィールドが含まれる場合があります。