Assembly Notification を再送する
Assembly Notification の配信を再試行します。
https://api2.transloadit.com/ assembly_notifications/ {assemblyId}/ replayAssembly Notification をリプレイし、Assembly の結果 JSON を含む POST リクエストを再度送信します。上書きしない限り、リプレイでは元の notify_url のテンプレートを再利用し、元の Assembly の fields ではなく、リプレイ時に指定された値を使って、その fields プレースホルダーを再評価します。必要な fields を再度指定するか、目的の解決済み URL を notify_url に渡してください。
再利用されるのは、元の Assembly リクエストで指定された notification_payload フィルターのみです。Template でのみ定義されたフィルターは、リプレイ時には保持されません。
リプレイ時の署名には通常、Assembly Status に記録された Auth Key が使用され、フォールバックとして、認証済みのリプレイ呼び出し元のシークレットが使用されます。リプレイされた Assembly は、親の過去のキー ID を保持するため、両方のキーが引き続き有効であっても、Notification のリプレイでは、その Assembly の最初の Notification とは異なるシークレットが使われることがあります。Webhook の署名シークレット選択ルールに従って、受信側を設定してください。
リプレイリクエストは https://api2.transloadit.com に送信できます。API2 は必要に応じて、署名済みの params または Bearer 認証情報を Assembly のリージョンに転送します。Assembly Status レスポンスの assembly_ssl_url に含まれる HTTPS オリジンを使用して、そのリージョンに直接アクセスすることもできます。
リクエスト例
ASSEMBLY_ID に、パーセントエンコードせずにリソースの値を設定してください。
サーバー側のシェルで、TRANSLOADIT_TOKEN に適切な Bearer トークンを設定し、curl を使ってこのリクエストを実行してください。トークンが必要な場合は、以下のセットアップ手順を展開してください。
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=assemblies: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 POST \
--url "https://api2.transloadit.com/assembly_notifications/${ASSEMBLY_ID:?Set ASSEMBLY_ID}/replay" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"wait":true}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: assemblies:write。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
パスパラメーター
assemblyId(パスセグメント)、必須。パターン:^[a-z0-9]{32}$
フォームフィールド
コンテンツタイプ: application/x-www-form-urlencoded
params(JSON 文字列)、必須。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | Assembly Notification の再送に使用する Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | objectこの再送で使用する Notification URL のプレースホルダーで利用できる値。元の Assembly のフィールド値は引き継がれません。URL テンプレートに必要なフィールドはすべて再指定してください。未指定のプレースホルダーは空文字列に置き換えられます。 追加プロパティのスキーマ任意の値 |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | null | stringこのリプレイに対して、元の Assembly Notification の URL を上書きします。省略した場合、null を指定した場合、または空文字列を指定した場合は、以前に解決された URL ではなく、元の URL テンプレートを再利用します。フィールドのプレースホルダーは、リプレイで指定されたフィールドのみを使用して再評価されます。必要なフィールドを再度指定するか、使用したい解決済みの URL を渡してください。 |
params. | booleanリプレイの実行が完了するまで待機します。省略した場合のデフォルトは true です。false の場合は、リプレイを開始した直後に戻ります。リプレイ API の成功レスポンスは、true の場合でも、Webhook の配信を確認するものではありません。Assembly Notification の一覧で、記録されている配信ステータスと response_code を確認してください。 |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.fields, params.nonce, params.notify_url, params.wait
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.fields, params.nonce, params.notify_url, params.wait
| フィールド | 型と説明 |
|---|---|
params. | Assembly Notification の再送に使用する Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"notification_id": "notification-id",
"ok": "ASSEMBLY_NOTIFICATION_REPLAYED",
"success": true
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 |
|---|---|
notification_id必須 | string (最小長: 1) |
ok必須 | "ASSEMBLY_NOTIFICATION_REPLAYED" | "ASSEMBLY_NOTIFICATION_REPLAYING" |
success必須 | boolean (常に: true) |
エラーレスポンス
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追加プロパティのスキーマ任意の値 |
wait が false の場合、成功コードは ASSEMBLY_NOTIFICATION_REPLAYING です。
wait: true の場合でも、リプレイ API の成功レスポンスはリプレイの実行が完了したことを意味し、Webhook が配信されたことを意味するわけではありません。配信に失敗しても、リプレイ API のレスポンスは失敗にはなりません。Assembly Notifications を取得で、記録された status と response_code を確認してください。配信を確認するには、response_code が 2xx であることを必須条件としてください。配信に失敗しても、Notification レコードに error フィールドが保存されるとは限りません。
Notification の一覧の各項目には、リプレイレスポンスの notification_id は公開されません。また、同時に実行される複数のリプレイが同じ start タイムスタンプを持つ場合があります。過去の成功レコードでは、たった今リクエストしたリプレイの配信を確認することはできません。特定のリプレイを識別するには、明示的に指定した notify_url のクエリ文字列に、アプリケーションで定義した一意のマーカーを含め、記録された url を受信側の配信ログと照合してください。機密情報ではないマーカーを使用してください。URL フラグメントは受信側には送信されません。