Template 認証情報の種類を取得する
Transloadit がサポートする Template 認証情報の種類を一覧表示します。
https://api2.transloadit.com/ template_credentials/ types以下のリクエスト例を実行して、現在のサービスのフィールドを確認してください。レスポンスの
types で使用するサービスを選択し、types[service].fields を調べてください。たとえば、types.s3.fields には、S3 の認証情報で受け付けられるフィールドが記述されています。
認証情報を作成または更新するときは、これらのフィールド名を content オブジェクト内で使用してください。requiredOnCreate が true に設定されているフィールドには、認証情報の作成時に空でない値を指定する必要があります。requiredOnUpdate が true に設定されているフィールドには、更新時に content を指定する場合、必ず空でない値を指定する必要があります。どちらのフラグについても、省略されているか false の場合は、対応する操作でそのフィールドは必須ではありません。content を省略した場合の動作とシークレットの保持動作については、認証情報の更新を参照してください。
ダウンロードできるスキーマが記述するのは、このレスポンスの構造であり、現在のサービスカタログではありません。認証済みのディスカバリーレスポンスが、フィールド名、説明、要件を提供します。
リクエスト例
解約済みの Workspaces では、新しい Bearer トークンを作成できません。既存の有効な Auth Key があれば、このエンドポイントは引き続き利用できます。以下のトークン設定の代わりに、署名付き読み取りの手順を使用してください。そのキーは、このエンドポイントに必要なスコープを付与している必要があります。
サーバー側のシェルで、curl と、TRANSLOADIT_TOKEN に設定した適切な Bearer トークンを使用して、このリクエストを実行してください。トークンが必要な場合は、以下の設定手順を展開してください。
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')"; 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/types" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
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. | 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 キー |
レスポンス
2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
エラーレスポンス
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追加プロパティのスキーマ任意の値 |