Was ist ein Template?
Ein Template speichert Transloadit Assembly Instructions sicher in einem Workspace und wird in API-Anfragen über eine template_id referenziert. Dadurch können Clients einen vordefinierten Verarbeitungsworkflow aufrufen, ohne dessen vollständige Instructions zu übermitteln.
So funktionieren Templates
Ein Transloadit-Template ist eine Workflow-Definition, die in einem Workspace verwaltet wird. Ihr JSON beschreibt benannte Assembly Steps, deren Parameter und wie Ausgaben früherer Steps an spätere weitergegeben werden. Durch den Verweis auf eine gespeicherte Definition müssen nicht bei jeder Erstellungsanfrage vollständige Instructions gesendet werden. Der Workflow wird dadurch jedoch nicht vertraulich: Der Assembly Status kann template und merged_params offenlegen. Eigenschaften, die zur Anfragezeit in params übergeben werden, werden mit Ausnahme von allow_steps_override selbst rekursiv mit dem geladenen Template zusammengeführt und überschreiben dabei dessen Werte gemäß der dort geltenden Richtlinie für Step-Überschreibungen. Diese Zusammenführung ermöglicht auch Variationen zur Laufzeit. Templates stehen zwischen Anwendungsanfragen und der Ausführung von Assemblies. Ihr Änderungsmanagement gehört daher zum Integrationsvertrag.
Wichtige Fakten
- 1Step-Namen dienen innerhalb von Assembly Instructions als Referenzen. Das Umbenennen eines Steps kann daher nachgelagerte Beziehungen über
useunterbrechen, selbst wenn jeder einzelne Vorgang syntaktisch gültig bleibt. - 2Mit
template_idwerden gespeicherte Instructions ausgewählt, eine API-Anfrage wird dadurch allein jedoch nicht authentifiziert. Die Kontoauthentifizierung und etwaige Anforderungen an die Signierung von Anfragen bleiben separate Kontrollen. - 3Setzen Sie
allow_steps_overrideim gespeicherten Template auffalse, um Anfragen abzulehnen, die zusätzlich Steps übergeben. Andere Anfrageparameter können gespeicherte Werte weiterhin überschreiben. Verlangen Sie Signature Authentication, wenn ein Auth Key zur Authentifizierung einer Anfrage verwendet wird, und lassen Sie ein vertrauenswürdiges Backend ausschließlich genehmigte Parameter signieren. Gültige Bearer-Token umgehen diese Anforderung und unterliegen weiterhin ihren Scopes und Beschränkungen auf die vorgesehenen technischen Empfänger. Signaturen erfassenparamsin serialisierter Form, jedoch keine separaten Upload-Formularfelder. Diese unsignierten Felder befüllen${fields.*}und überschreiben gleichnamige signierte Werte infields. Diese Kontrollen allein sichern dynamische Eingaben daher nicht ab. Leiten Sie aus diesen Feldern keine Einstellungen ab, die Aufrufende nicht selbst wählen dürfen. - 4Templates, die in einem Workspace erstellt werden, lassen sich nicht auf eine bestimmte Version festlegen. Um eine nicht abwärtskompatible Änderung sicher vorzunehmen, erstellen Sie ein neues Template mit einem eigenen Wert für
template_idund stellen Sie die aufrufenden Anwendungen darauf um. Nur die Builtin Templates von Transloadit werden von Transloadit versioniert.
Wann Templates wichtig sind
Verwenden Sie ein Template, um Workflow-Änderungen zentral zu verwalten und nicht bei jeder Erstellungsanfrage vollständige Assembly Instructions senden zu müssen. Setzen Sie allow_steps_override auf false, um Step-Überschreibungen zu verhindern. Verlangen Sie Signature Authentication mit vertrauenswürdiger Signierung, wenn ein Auth Key zur Authentifizierung einer Anfrage verwendet wird. Diese Kontrollen beschränken weder unsignierte Upload-Felder noch ersetzen sie Scope-Beschränkungen für Bearer-Token. Prüfen Sie dynamische Eingaben daher separat. Die Aktualisierung eines gemeinsam genutzten Templates kann alle aufrufenden Anwendungen betreffen. Inkompatible Änderungen können daher ein neues Template erfordern.