ストレージ内のアセットを取得
安定した識別子に基づいて、Workspace 内のアセットの現在のバージョン、または明示的に保持されているバージョンを返します。
https://api2.transloadit.com/ dam/ assets/ {assetId}このエンドポイントを呼び出す前に、リクエストで使用する Auth Key と同じ Workspace にある既存のアセットの ID を取得してください。
/transloadit/store で保存したファイルについては、その Assembly Status を取得し、ASSEMBLY_COMPLETED になるまで待ってください。返された results[stepName] 配列内で、保存された各ファイルの workspace、asset_id、version_id、および返された path を保持してください。通常のファイルの id は、そのファイルのストレージアセット ID ではありません。以下の例では、ASSET_ID または params.asset_ids に asset_id を使用してください。
ネイティブの移動や名前変更を経てもアセットを追跡するには、asset_id を使用してください。上書き後も、保持されている同一のバイト列を選択するには、インポート時に version_id を追加してください。保存したパスは変更可能な場所を示すものであり、不変の参照ではありません。アクセスとバージョン保持に関するルールは引き続き適用されます。
現在のバージョンを取得するには、version_id を省略してください。指定すると、このアセットの保持されている特定の 1 つのバージョンを取得できます。バージョンが存在しない場合、削除されている場合、または所有者が異なる場合はエラーが返されます。現在のバイト列にフォールバックすることはありません。
返される asset の参照形式は、保存された Assembly の結果と同じです。古いバージョンを選択した場合でも、そのパスはアセットの現在の場所を反映します。
リクエスト例
ASSET_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=dam:read dam:write')"; 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/dam/assets/${ASSET_ID:?Set ASSET_ID}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: dam:read, dam:write。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
パスパラメーター
assetId(パスセグメント)、必須。パターン:^[A-Za-z0-9_-]{21}[AQgw]$, 最小長: 22, 最大長: 22
クエリパラメーター
params(JSON 文字列)。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
署名対象の params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | ストレージのメタデータリクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | "DELETE" | "GET" | "PATCH" | "POST"これらの署名済み params が認可するリクエストの HTTP メソッド。大文字で指定します。すべての署名付きリクエストで、 |
params. | string (最大長: 2048)これらの署名付き params が認可するリクエストの URL パス(例: 検証パターン(正規表現)^\/[^?#]*$ |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | string選択したアセットの保持されているバージョン(任意)。現在のバージョンを取得する場合は省略します。バージョンが存在しないか削除されている場合はエラーが返され、現在のバージョンのバイト列にフォールバックすることはありません。 検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$ |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.nonce, params.version_id
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.nonce, params.version_id
| フィールド | 型と説明 |
|---|---|
params. | ストレージのメタデータリクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
params. | "DELETE" | "GET" | "PATCH" | "POST"これらの署名済み params が認可するリクエストの HTTP メソッド。大文字で指定します。すべての署名付きリクエストで、 |
params. | string (最大長: 2048)これらの署名付き params が認可するリクエストの URL パス(例: 検証パターン(正規表現)^\/[^?#]*$ |
レスポンス
レスポンスボディの例を以下に示します:
{
"asset": {
"asset_id": "AAAAAAAAAAAAAAAAAAAAAA",
"height": 600,
"mime": "image/jpeg",
"path": "renamed.jpg",
"size": 12345,
"version_id": "AAAAAAAAAAAAAAAAAAAAAQ",
"width": 800,
"workspace": "example-workspace"
},
"message": "The Storage asset was successfully found.",
"ok": "DAM_ASSET_FOUND"
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 |
|---|---|
asset必須 |
|
asset.必須 | string安定したアセット ID です。ネイティブの移動や名前変更を行っても維持されます。現在のバイト列を選択するには、バージョンを指定せずにこの ID を使用してください。 検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$ |
asset. | booleanすべてのピクセルが不透明であっても、画像にアルファチャンネルがあるかどうかを示します。ThumbHash の抽出に成功した場合に含まれ、省略されている場合は不明であることを意味します。 |
asset. | integer (最小値(境界値を含まない): 0, 最大値: 9007199254740991)EXIF の向きを適用した後の表示の高さ(ピクセル単位、判明している場合)。 |
asset. | string保存されたバイト列の MD5 チェックサム(小文字表記、利用可能な場合)。 検証パターン(正規表現)^[a-f0-9]{32}$ |
asset.必須 | null | string保存されているバイト列の MIME タイプ。不明な場合は null。 |
asset.必須 | string (最小長: 1)Workspace を基準とした、変更可能な現在の場所です。名前を変更すると、以前のパスは最新の場所を示さなくなります。上書きによって、このパスにあるデータのバイト列が変わることがあります。 |
asset. | string保存されたバイト列の SHA-256 チェックサム(小文字表記、利用可能な場合)。 検証パターン(正規表現)^[a-f0-9]{64}$ |
asset.必須 | integer (最小値: 0, 最大値: 9007199254740991)保存されているファイルのサイズ(バイト単位)。 |
asset. | stringこのバージョンの表示ピクセルを表す、Base64 エンコードされた ThumbHash。このバージョンを生成した Step で output_meta.thumbhash を指定して要求した場合に提供されます。これは画像データです。オリジナルと同じアクセス制御を適用してください。 検証パターン(正規表現)^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$ |
asset.必須 | stringこのアセットの特定の変更不可能なバージョンです。asset_id と組み合わせて、保持されているバイト列を選択します。バージョンが存在しない場合、現在のバージョンにフォールバックすることは決してありません。 検証パターン(正規表現)^[A-Za-z0-9_-]{21}[AQgw]$ |
asset. | integer (最小値(境界値を含まない): 0, 最大値: 9007199254740991)EXIF の向きを適用した後の表示幅(ピクセル単位、判明している場合)。 |
asset.必須 | string (最小長: 1)このアセットを所有する Workspace のスラッグ。このアセットを読み取る、または管理する際は、同じ Workspace に対して認証してください。 |
message必須 | string (最小長: 1) |
ok必須 | string (常に: "DAM_ASSET_FOUND") |
エラーレスポンス
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追加プロパティのスキーマ任意の値 |