Transloadit

Assembly Notification erneut senden

Versucht erneut, eine Assembly Notification zuzustellen.

POSThttps://api2.transloadit.com/assembly_notifications/{assemblyId}/replay

Sendet eine Assembly Notification erneut, indem die POST-Anfrage mit dem Ergebnis-JSON der Assembly erneut gesendet wird. Sofern nichts anderes angegeben wird, verwendet das erneute Senden die ursprüngliche notify_url-Vorlage wieder und wertet deren fields-Platzhalter anhand der für das erneute Senden übergebenen Werte neu aus, nicht anhand der fields der ursprünglichen Assembly. Übergeben Sie alle erforderlichen fields erneut oder übergeben Sie die gewünschte aufgelöste URL in notify_url.

Nur notification_payload-Filter, die in der ursprünglichen Assembly-Anfrage übergeben wurden, werden wiederverwendet. Filter, die nur in einem Template definiert sind, bleiben beim erneuten Senden nicht erhalten.

Das Signieren beim erneuten Senden verwendet normalerweise den im Assembly Status aufgezeichneten Auth Key, ersatzweise das Secret des authentifizierten Aufrufers der Anfrage zum erneuten Senden. Eine erneut ausgeführte Assembly behält die historische Schlüssel-ID ihrer übergeordneten Assembly bei, sodass beim erneuten Senden einer Notification ein anderes Secret verwendet werden kann als bei der ursprünglichen Notification dieser Assembly, selbst wenn beide Schlüssel weiterhin aktiv sind. Konfigurieren Sie Ihren Empfänger entsprechend den Regeln zur Auswahl des Secrets für die Webhook-Signierung.

Sie können Anfragen zum erneuten Senden an https://api2.transloadit.com senden. API2 leitet bei Bedarf signierte params oder Bearer-Zugangsdaten an die Region der Assembly weiter. Sie können auch den HTTPS-Origin aus assembly_ssl_url in der Assembly Status-Antwort verwenden, um die Region der Assembly direkt zu kontaktieren.

Beispielanfrage

Setzen Sie ASSEMBLY_ID auf den Wert Ihrer Ressource, ohne Prozentkodierung anzuwenden.

Führen Sie diese Anfrage in einer serverseitigen Shell mit curl und einem geeigneten Bearer-Token in TRANSLOADIT_TOKEN aus. Wenn Sie ein Token benötigen, klappen Sie die nachfolgende Einrichtung auf.

Benötigen Sie ein Bearer-Token?

Setzen Sie in einer vertrauenswürdigen serverseitigen Shell mit curl und jq die Variablen TRANSLOADIT_KEY und TRANSLOADIT_SECRET auf Ihren Auth Key bzw. Ihr Auth Secret. Halten Sie beide Zugangsdaten und das resultierende Token geheim; führen Sie diese Einrichtung niemals im Browsercode aus.

Erstellen Sie zunächst ein Token mit den für diesen Endpunkt erforderlichen Scopes. Ihr Auth Key muss diese Scopes bereits gewähren.

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

Lassen Sie diese Shell geöffnet und führen Sie die folgende Anfrage aus. Verwenden Sie das Token wieder, solange es gültig bleibt.

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}'

Authentifizierung

Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.

Erforderlicher Berechtigungsumfang für Auth Key oder Bearer-Token: assemblies:write.

Signierte Anfragen erfordern sowohl eine signature als auch einen in der Zukunft liegenden Zeitstempel für params.auth.expires. Bearer-Tokens erfordern keines von beiden.

Pfadparameter

  • assemblyId (Pfadsegment), erforderlich. Muster: ^[a-z0-9]{32}$

Formularfelder

Content-Type: application/x-www-form-urlencoded

  • params (JSON-Zeichenfolge), erforderlich. Ein JSON-codiertes Objekt, dessen unterstützte Schlüssel unten aufgeführt sind.

  • signature (Zeichenfolge). Für signierte Anfragen erforderlich. Lassen Sie dieses Feld weg, wenn Sie ein Bearer-Token verwenden.

Unterstützte Schlüssel im Feld params

Die Authentifizierungsfelder in dieser Liste gelten für signierte Anfragen. Mit einem Bearer-Token können Sie params.auth und das separate Feld signature weglassen. Vergleichen Sie unten die Anfrageparameter der einzelnen Authentifizierungsmethoden.

Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

FeldTyp und Beschreibung
params.auth

für signierte Anfragen erforderlich; mit einem Bearer-Token optional

object

Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication beim erneuten Versand einer Assembly Notification.

params.auth: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

params.auth.expires

erforderlich

string

ISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen.

params.auth.key

erforderlich

string

Transloadit API-Schlüssel zur Authentifizierung von Anfragen

params.fields
object

Werte, die den Platzhaltern in der für diesen erneuten Versand verwendeten Notification-URL zur Verfügung stehen. Die Feldwerte der ursprünglichen Assembly werden nicht übernommen. Geben Sie alle für die URL-Vorlage benötigten Felder erneut an; fehlende Platzhalter werden durch leere Zeichenfolgen ersetzt.

Schema für zusätzliche Eigenschaften
beliebiger Wert
params.nonce
string | integer

Eindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann.

params.notify_url
null | string

Überschreibt die ursprüngliche Assembly Notification-URL für diesen erneuten Versand. Bei Auslassung, null oder einer leeren Zeichenfolge wird die ursprüngliche URL-Vorlage wiederverwendet, nicht die zuvor aufgelöste URL. Feldplatzhalter werden erneut ausgewertet, ausschließlich mit den beim erneuten Versand angegebenen Feldern. Geben Sie alle erforderlichen Felder erneut an oder übergeben Sie die gewünschte aufgelöste URL.

params.wait
boolean

Wartet, bis die Ausführung des erneuten Versands abgeschlossen ist. Wird der Parameter weggelassen, ist der Standardwert true; false gibt die Antwort unmittelbar nach dem Start zurück. Eine erfolgreiche API-Antwort zum erneuten Versand bestätigt keine Webhook-Zustellung, auch nicht bei true. Prüfen Sie den gespeicherten Zustellungsstatus und response_code in der Liste der Assembly Notifications.

Anfrageparameter nach Authentifizierungsmethode

Mit signierten Parametern

Geben Sie Ihren Auth Key als params.auth.key an. Wenn Sie die Anfrage signieren, geben Sie einen in der Zukunft liegenden Zeitstempel für params.auth.expires an und senden Sie die Signature im separaten Feld signature. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.

Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

Verwendet die oben angegebenen Felddefinitionen: params.auth, params.fields, params.nonce, params.notify_url, params.wait

Mit einem Bearer-Token

Senden Sie das Bearer-Token im Authorization-Header. Sie können params.auth und das separate Feld signature weglassen. Die übrigen erforderlichen Parameter müssen weiterhin angegeben werden. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.

Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

Verwendet die oben angegebenen Felddefinitionen: params.fields, params.nonce, params.notify_url, params.wait

FeldTyp und Beschreibung
params.auth
object

Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication beim erneuten Versand einer Assembly Notification.

params.auth: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.

params.auth.expires
string

ISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen.

params.auth.key
string

Transloadit API-Schlüssel zur Authentifizierung von Anfragen

Antwort

Hier sehen Sie ein Beispiel für einen Antworttext:

{
  "notification_id": "notification-id",
  "ok": "ASSEMBLY_NOTIFICATION_REPLAYED",
  "success": true
}

2xx-Erfolg

JSON-Response-Body. application/json text/plain; charset=utf-8

Schema des Response-Bodys
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Die Antwort enthält nur die für dieses Objekt aufgeführten Felder.

FeldTyp und Beschreibung
notification_id

erforderlich

string (minimale Länge: 1)
ok

erforderlich

"ASSEMBLY_NOTIFICATION_REPLAYED" | "ASSEMBLY_NOTIFICATION_REPLAYING"
success

erforderlich

boolean (immer: true)

Fehlerantwort

JSON-Response-Body. application/json text/plain; charset=utf-8

Schema des Response-Bodys
Vollständiges JSON Schema

JSON in einem neuen Tab öffnen

Mindestens eine dieser Eigenschaften ist erforderlich: error, message, reason

Die Antwort kann zusätzliche Felder enthalten.

FeldTyp und Beschreibung
assembly_id
string
error
string (minimale Länge: 1)
http_code
number | string
  • number
  • string
    Validierungsmuster (regulärer Ausdruck)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*[+-]?0*(?:0(?:[^0-9]|$)|(?:[1-9][0-9]{0,307}|1(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-5][0-9]{4}|7976[0-8][0-9]{3}|79769[0-2][0-9]{2}|7976930[0-9]{1}|7976931[0-2])[0-9]{300}|79769313(?:(?:[0-3][0-9]{7}|4[0-7][0-9]{6}|48[0-5][0-9]{5}|486[0-1][0-9]{4}|4862[0-2][0-9]{3}|486230[0-9]{2}|486231[0-4][0-9]{1}|4862315[0-7])[0-9]{292}|48623158(?:(?:0[0-6][0-9]{6}|07[0-8][0-9]{5}|079[0-2][0-9]{4}|0793[0-6][0-9]{3}|07937[0-1][0-9]{2}|079372[0-7][0-9]{1}|0793728[0-8])[0-9]{284}|07937289(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-3][0-9]{5}|7140[0-4][0-9]{3}|71405[0-2][0-9]{2}|7140530[0-2])[0-9]{276}|71405303(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-4][0-9]{5}|4150[0-6][0-9]{3}|41507[0-8][0-9]{2}|415079[0-8][0-9]{1}|4150799[0-2])[0-9]{268}|41507993(?:(?:[0-3][0-9]{7}|40[0-9]{6}|41[0-2][0-9]{5}|413[0-1][0-9]{4}|4132[0-6][0-9]{3}|413270[0-9]{2})[0-9]{260}|41327100(?:(?:[0-2][0-9]{7}|3[0-6][0-9]{6}|37[0-7][0-9]{5}|378[0-1][0-9]{4}|3782[0-5][0-9]{3}|37826[0-8][0-9]{2}|378269[0-2][0-9]{1}|3782693[0-5])[0-9]{252}|37826936(?:(?:0[0-9]{7}|1[0-6][0-9]{6}|17[0-2][0-9]{5}|173[0-6][0-9]{4}|1737[0-6][0-9]{3}|17377[0-7][0-9]{2}|173778[0-8][0-9]{1}|1737789[0-7])[0-9]{244}|17377898(?:(?:0[0-3][0-9]{6}|04[0-3][0-9]{5}|044[0-3][0-9]{4}|0444[0-8][0-9]{3}|04449[0-5][0-9]{2}|044496[0-7][0-9]{1}|0444968[0-1])[0-9]{236}|04449682(?:(?:[0-8][0-9]{7}|9[0-1][0-9]{6}|92[0-6][0-9]{5}|927[0-5][0-9]{4}|9276[0-3][0-9]{3}|92764[0-6][0-9]{2}|927647[0-4][0-9]{1})[0-9]{228}|92764750(?:(?:[0-8][0-9]{7}|9[0-3][0-9]{6}|94[0-5][0-9]{5}|946[0-5][0-9]{4}|9466[0-3][0-9]{3}|94664[0-8][0-9]{2}|94664900)[0-9]{220}|94664901(?:(?:[0-6][0-9]{7}|7[0-8][0-9]{6}|79[0-6][0-9]{5}|797[0-6][0-9]{4}|7977[0-4][0-9]{3}|79775[0-7][0-9]{2}|797758[0-6][0-9]{1}|7977587[0-1])[0-9]{212}|79775872(?:(?:0[0-6][0-9]{6}|070[0-8][0-9]{4}|0709[0-5][0-9]{3}|07096[0-2][0-9]{2}|070963[0-2][0-9]{1})[0-9]{204}|07096330(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-5][0-9]{5}|286[0-3][0-9]{4}|28640[0-9]{3}|28641[0-5][0-9]{2}|286416[0-5][0-9]{1}|2864166[0-8])[0-9]{196}|28641669(?:(?:[0-1][0-9]{7}|2[0-7][0-9]{6}|28[0-7][0-9]{5}|288[0-6][0-9]{4}|2887[0-8][0-9]{3}|288790[0-9]{2}|2887910[0-8])[0-9]{188}|28879109(?:(?:[0-3][0-9]{7}|4[0-5][0-9]{6}|46[0-4][0-9]{5}|465[0-4][0-9]{4}|4655[0-4][0-9]{3}|46555[0-4][0-9]{2}|465555[0-3][0-9]{1}|4655554[0-6])[0-9]{180}|46555547(?:(?:[0-7][0-9]{7}|8[0-4][0-9]{6}|850[0-9]{5}|851[0-8][0-9]{4}|8519[0-3][0-9]{3}|851940[0-3][0-9]{1})[0-9]{172}|85194040(?:(?:[0-1][0-9]{7}|2[0-5][0-9]{6}|26[0-2][0-9]{5}|2630[0-5][0-9]{3}|26306[0-4][0-9]{2}|263065[0-6][0-9]{1}|2630657[0-3])[0-9]{164}|26306574(?:(?:[0-7][0-9]{7}|8[0-7][0-9]{6}|88[0-5][0-9]{5}|886[0-6][0-9]{4}|88670[0-9]{3}|88671[0-4][0-9]{2}|8867150[0-4])[0-9]{156}|88671505(?:(?:[0-7][0-9]{7}|8[0-1][0-9]{6}|820[0-5][0-9]{4}|8206[0-7][0-9]{3}|820680[0-9]{2}|820681[0-8][0-9]{1})[0-9]{148}|82068190(?:(?:[0-7][0-9]{7}|8[0-8][0-9]{6}|890[0-1][0-9]{4}|8902000[0-6])[0-9]{140}|89020007(?:(?:0[0-7][0-9]{6}|08[0-2][0-9]{5}|083[0-7][0-9]{4}|0838[0-2][0-9]{3}|08383[0-5][0-9]{2}|083836[0-6][0-9]{1}|0838367[0-5])[0-9]{132}|08383676(?:(?:[0-1][0-9]{7}|2[0-6][0-9]{6}|27[0-2][0-9]{5}|273[0-7][0-9]{4}|2738[0-4][0-9]{3}|27385[0-3][0-9]{2}|273854[0-7][0-9]{1}|2738548[0-3])[0-9]{124}|27385484(?:(?:[0-4][0-9]{7}|5[0-7][0-9]{6}|580[0-9]{5}|581[0-6][0-9]{4}|5817[0-6][0-9]{3}|581770[0-9]{2}|5817710[0-9]{1}|5817711[0-4])[0-9]{116}|58177115(?:(?:[0-2][0-9]{7}|30[0-9]{6}|31[0-6][0-9]{5}|317[0-5][0-9]{4}|3176[0-3][0-9]{3}|31764[0-3][0-9]{2}|317644[0-6][0-9]{1}|3176447[0-4])[0-9]{108}|31764475(?:(?:[0-6][0-9]{7}|7[0-2][0-9]{6}|730[0-1][0-9]{4}|7302[0-6][0-9]{3}|7302700[0-5])[0-9]{100}|73027006(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-4][0-9]{5}|985[0-4][0-9]{4}|9855[0-4][0-9]{3}|98555[0-6][0-9]{2}|9855570[0-9]{1}|9855571[0-2])[0-9]{92}|98555713(?:(?:[0-5][0-9]{7}|6[0-5][0-9]{6}|66[0-8][0-9]{5}|669[0-4][0-9]{4}|6695[0-8][0-9]{3}|66959[0-5][0-9]{2}|669596[0-1][0-9]{1}|6695962[0-1])[0-9]{84}|66959622(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-1][0-9]{5}|842[0-8][0-9]{4}|84290[0-9]{3}|84291[0-3][0-9]{2}|842914[0-7][0-9]{1}|84291480)[0-9]{76}|84291481(?:(?:[0-8][0-9]{7}|9[0-7][0-9]{6}|98[0-5][0-9]{5}|9860[0-7][0-9]{3}|98608[0-2][0-9]{2}|986083[0-3][0-9]{1}|9860834[0-8])[0-9]{68}|98608349(?:(?:[0-2][0-9]{7}|3[0-5][0-9]{6}|36[0-3][0-9]{5}|364[0-6][0-9]{4}|3647[0-4][0-9]{3}|36475[0-1][0-9]{2}|364752[0-8][0-9]{1}|3647529[0-1])[0-9]{60}|36475292(?:(?:[0-6][0-9]{7}|70[0-9]{6}|71[0-8][0-9]{5}|7190[0-6][0-9]{3}|71907[0-3][0-9]{2}|7190740[0-9]{1}|7190741[0-5])[0-9]{52}|71907416(?:(?:[0-7][0-9]{7}|8[0-3][0-9]{6}|84[0-3][0-9]{5}|844[0-3][0-9]{4}|8444[0-2][0-9]{3}|84443[0-5][0-9]{2}|844436[0-4][0-9]{1}|8444365[0-4])[0-9]{44}|84443655(?:(?:0[0-9]{7}|10[0-6][0-9]{5}|1070[0-3][0-9]{3}|10704[0-2][0-9]{2}|107043[0-3][0-9]{1}|1070434[0-1])[0-9]{36}|10704342(?:(?:[0-6][0-9]{7}|70[0-9]{6}|710[0-9]{5}|711[0-4][0-9]{4}|7115[0-4][0-9]{3}|71155[0-8][0-9]{2}|711559[0-5][0-9]{1}|7115596[0-8])[0-9]{28}|71155969(?:(?:[0-8][0-9]{7}|9[0-4][0-9]{6}|950[0-7][0-9]{4}|95080[0-8][0-9]{2}|950809[0-2][0-9]{1})[0-9]{20}|95080930(?:(?:[0-3][0-9]{7}|4[0-1][0-9]{6}|42[0-7][0-9]{5}|428[0-7][0-9]{4}|428800[0-9]{2}|428801[0-6][0-9]{1}|4288017[0-6])[0-9]{12}|42880177(?:(?:[0-8][0-9]{7}|90[0-3][0-9]{5}|9040[0-9]{4}|9041[0-6][0-9]{3}|90417[0-3][0-9]{2}|904174[0-3][0-9]{1}|9041744[0-8])[0-9]{4}|90417449(?:(?:[0-6][0-9]{3}|7[0-6][0-9]{2}|77[0-8][0-9]{1}|7790)|7791))))))))))))))))))))))))))))))))))))))))(?:[^0-9]|$))
message
string

Menschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code error, wenn Sie einen bestimmten Fehlerfall behandeln.

reason
null | string | number | boolean | Array<beliebiger Wert> | object

Eines der folgenden Schemas kann gelten:

null
string
number
boolean
Array<beliebiger Wert>
Array<beliebiger Wert>
Schema eines Array-Elements
beliebiger Wert
object
object
Schema für zusätzliche Eigenschaften
beliebiger Wert

Wenn wait den Wert false hat, lautet der Erfolgscode ASSEMBLY_NOTIFICATION_REPLAYING.

Auch bei wait: true bedeutet eine erfolgreiche API-Antwort auf das erneute Senden, dass der Sendevorgang abgeschlossen ist, nicht aber, dass der Webhook zugestellt wurde. Zustellungsfehler führen nicht dazu, dass die API-Antwort auf das erneute Senden fehlschlägt. Prüfen Sie die aufgezeichneten Werte für status und response_code mithilfe von Assembly Notifications abrufen; setzen Sie zur Bestätigung der Zustellung einen response_code von 2xx voraus. Eine fehlgeschlagene Zustellung garantiert nicht, dass im Notification-Datensatz ein error-Feld gespeichert ist.

Einträge in der Liste der Notifications enthalten nicht die notification_id aus der Antwort auf das erneute Senden, und gleichzeitige erneute Sendevorgänge können denselben start-Zeitstempel haben. Ein älterer erfolgreicher Datensatz bestätigt nicht die Zustellung beim soeben von Ihnen angeforderten erneuten Senden. Um einen bestimmten erneuten Sendevorgang zu identifizieren, fügen Sie eine eindeutige, anwendungsdefinierte Markierung in den Query-String einer expliziten notify_url ein und gleichen Sie die aufgezeichnete url mit den Zustellungsprotokollen Ihres Empfängers ab. Verwenden Sie eine nicht geheime Markierung; URL-Fragmente werden nicht an Ihren Empfänger gesendet.