Créer un nouveau Template
Crée un Template réutilisable à partir d’Assembly Instructions.
https://api2.transloadit.com/Les nouveaux Templates, y compris les copies, sont toujours créés avec la planification Cron désactivée. Un Workspace payant ayant reçu une invitation peut enregistrer sa région cron, sa planification UTC et son ID d’Auth Key lors de la création d’un Template, puis activer explicitement la planification dans une mise à jour distincte après avoir examiné ces paramètres.
Exemple de requête
Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur approprié dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, développez la section de configuration ci-dessous.
Besoin d’un jeton porteur ?
Dans un shell de confiance côté serveur avec curl et jq, définissez TRANSLOADIT_KEY et TRANSLOADIT_SECRET avec votre Auth Key et votre Auth Secret. Gardez ces deux informations d’identification et le jeton obtenu secrets ; n’exécutez jamais cette configuration dans du code de navigateur.
Commencez par créer un jeton avec les portées requises par ce point de terminaison. Votre Auth Key doit déjà accorder ces portées.
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=templates: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
Gardez ce shell ouvert et exécutez la requête ci-dessous. Réutilisez le jeton tant qu’il reste valide.
curl --fail-with-body -sS --request POST \
--url "https://api2.transloadit.com/templates" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"name":"resize-images","template":{"steps":{"resize":{"robot":"/image/resize","use":":original","width":320}}}}'
Authentification
Ce point de terminaison accepte des params signés ou un jeton porteur. Consultez la section Authentification pour les instructions de configuration.
Portée requise pour l’Auth Key ou le jeton porteur : templates:write.
Les requêtes signées nécessitent à la fois une signature et un horodatage params.auth.expires situé dans le futur. Les jetons porteurs ne nécessitent ni l’un ni l’autre.
Champs de formulaire
Type de contenu : application/x-www-form-urlencoded
params(Chaîne JSON), obligatoire. Un objet encodé en JSON dont les clés prises en charge sont répertoriées ci-dessous.signature(chaîne de caractères). Obligatoire pour les requêtes signées. Omettez ce champ lorsque vous utilisez un jeton porteur.
Clés prises en charge dans le champ params
Les champs d’authentification de cette liste s’appliquent aux requêtes signées. Avec un jeton porteur, vous pouvez omettre params.auth et le champ distinct signature. Comparez les paramètres de requête spécifiques à l’authentification ci-dessous.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
| Champ | Type et description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params. | "1day" | "30days" | "7days" | "90days" | "NoSave"Définit la durée de conservation de l’Assembly Status pour les Assemblies créées à partir de ce Template. | ||||||||||||||||||||||||||||||||||||
params.obligatoire pour les requêtes signées ; facultatif avec un jeton porteur | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête de Template.
| ||||||||||||||||||||||||||||||||||||
params.obligatoire | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. | ||||||||||||||||||||||||||||||||||||
params.obligatoire | stringClé API Transloadit utilisée pour authentifier les requêtes | ||||||||||||||||||||||||||||||||||||
params. | string | nullIdentifiant d’une Auth Key active et non expirée appartenant à ce Workspace, avec l’autorisation de créer des Assemblies. Requis lors de l’activation de la préversion payante sur invitation des Templates Cron. La clé doit autoriser la signature et ne peut pas être une clé interne. Motif de validation (expression régulière)^[a-f0-9]{32}$ | ||||||||||||||||||||||||||||||||||||
params. | boolean (par défaut : false)Les nouveaux Templates et les copies sont toujours créés avec la planification désactivée, y compris lorsque ce champ vaut true. Activez la planification au moyen d’une mise à jour distincte du Template après avoir examiné sa région, sa planification, ses Instructions et son Auth Key. | ||||||||||||||||||||||||||||||||||||
params. | integer (minimum : 1, maximum : 10)Nombre maximal d’exécutions planifiées simultanées de ce Template. Vaut 1 par défaut à la création ; lors d’une mise à jour, omettre ce paramètre conserve la limite enregistrée. Les déclenchements qui surviennent lorsque la limite est atteinte sont ignorés, et non mis en file d’attente. Les démarrages en attente et les exécutions non résolues sont comptabilisés jusqu’à leur achèvement ou jusqu’à l’expiration du délai de perte de point de contrôle. Les exécutions perdues libèrent définitivement leur emplacement ; une Assembly tardive peut donc dépasser temporairement cette limite. Ce paramètre ne dédoublonne pas les fichiers importés et ne limite pas les Assemblies manuelles. Les limites habituelles du Workspace continuent de s’appliquer. | ||||||||||||||||||||||||||||||||||||
params. | "ap-southeast-1" | "eu-west-1" | "us-east-1" | nullAPI régionale utilisée pour les Assemblies planifiées. Requise lors de l’activation de la préversion payante sur invitation des Templates Cron. | ||||||||||||||||||||||||||||||||||||
params. | string | null (longueur minimale : 1, longueur maximale : 255)Expression cron numérique à six champs, évaluée en UTC : seconde, minute, heure, jour du mois, mois et jour de la semaine. Prend en charge les caractères génériques, les valeurs séparées par des virgules, les plages et les pas. Les déclenchements planifiés doivent être espacés d’au moins 10 secondes. La planification des Templates par cron est proposée en préversion payante sur invitation. | ||||||||||||||||||||||||||||||||||||
params.obligatoire | string (longueur minimale : 3, longueur maximale : 200)Nom de ce Template. Utilisez 3–200 lettres latines minuscules, chiffres ou tirets. Le nom Motif de validation (expression régulière)^(?:[a-su-z0-9-][a-z0-9-]{2,199}|t[a-ln-z0-9-][a-z0-9-]{1,198}|tm[a-oq-z0-9-][a-z0-9-]{0,197}|tmp[a-z0-9-]{1,197})$ | ||||||||||||||||||||||||||||||||||||
params. | string | integerValeur unique et aléatoire incluse dans les paramètres de la requête signée pour rendre chaque signature unique et empêcher la réutilisation accidentelle d’une signature. | ||||||||||||||||||||||||||||||||||||
params. | 0 | 1 (par défaut : 0)Utilisez | ||||||||||||||||||||||||||||||||||||
params.obligatoire | object | stringAssembly Instructions stockées dans ce Template. Privilégiez l’objet JSON structuré ; une chaîne encodée en JSON reste acceptée pour des raisons de compatibilité. N’importe lequel des schémas suivants peut s’appliquer : objectAssembly Instructions structurées stockées dans ce Template.
stringstringAssembly Instructions encodées en JSON, conservées pour la compatibilité avec les clients. Motif de validation (expression régulière)^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*\{(?:[^\x00]|\x00)*\}[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$ | ||||||||||||||||||||||||||||||||||||
params. | "1day" | "NoSave"Définit la durée de conservation des résultats du transcodage pour les Assemblies créées à partir de ce Template. |
Paramètres de requête par méthode d’authentification
Avec des paramètres signés
Incluez votre Auth Key dans params.auth.key. Lors de la signature de la requête, incluez un horodatage futur dans params.auth.expires et envoyez la signature dans le champ distinct signature. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.assembly_status_expiry, params.auth, params.cron_auth_key_id, params.cron_enabled, params.cron_max_concurrent_runs, params.cron_region, params.cron_schedule_with_seconds, params.name, params.nonce, params.require_signature_auth, params.template, params.transcoding_result_expiry
Avec un jeton porteur
Envoyez le jeton porteur dans l’en-tête Authorization. Vous pouvez omettre params.auth et le champ distinct signature. Les autres paramètres obligatoires restent requis. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.assembly_status_expiry, params.cron_auth_key_id, params.cron_enabled, params.cron_max_concurrent_runs, params.cron_region, params.cron_schedule_with_seconds, params.name, params.nonce, params.require_signature_auth, params.template, params.transcoding_result_expiry
| Champ | Type et description |
|---|---|
params. | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête de Template.
|
params. | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params. | stringClé API Transloadit utilisée pour authentifier les requêtes |
Réponse
Voici un exemple de corps de réponse :
{
"assembly_status_expiry": null,
"content": {
"steps": {
"resize": {
"robot": "/image/resize",
"use": ":original",
"width": 320
}
}
},
"id": "8fc3b9166c784afd824acf24269ebd11",
"message": "Your Template was successfully created.",
"name": "resize-images",
"ok": "TEMPLATE_CREATED",
"require_signature_auth": 0,
"transcoding_result_expiry": null
}Succès 2xx
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse contient uniquement les champs répertoriés pour cet objet.
| Champ | Type et description |
|---|---|
assembly_status_expiryobligatoire | null | string |
contentobligatoire | object | Array<n’importe quelle valeur> | string | number | boolean | nullN’importe lequel des schémas suivants peut s’appliquer : objectobjectSchéma de la propriété supplémentairen’importe quelle valeurArray<n’importe quelle valeur>Array<n’importe quelle valeur>Schéma d’un élément de tableaun’importe quelle valeurstringnumberbooleannull |
cron_auth_key_id | string | nullMotif de validation (expression régulière)^[a-f0-9]{32}$ |
cron_enabled | boolean |
cron_max_concurrent_runs | integer (minimum : 1, maximum : 10) |
cron_region | "ap-southeast-1" | "eu-west-1" | "us-east-1" | null |
cron_schedule_with_seconds | string | null (longueur minimale : 1, longueur maximale : 255) |
idobligatoire | stringN’importe lequel des schémas suivants peut s’appliquer : Variante 1: string (longueur maximale : 32)stringMotif de validation (expression régulière)^[\x00-\x7F]*$Variante 2: string (longueur maximale : 32)stringMotif de validation (expression régulière)^builtin\/[a-z0-9-]+(?:@[0-9a-z.-]+)?$ |
messageobligatoire | string (longueur minimale : 1) |
nameobligatoire | string (longueur minimale : 1, longueur maximale : 255) |
okobligatoire | string (toujours : "TEMPLATE_CREATED") |
require_signature_authobligatoire | 0 | 1 |
transcoding_result_expiryobligatoire | null | string |
Réponse d’erreur
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
assembly_id | string |
error | string (longueur minimale : 1) |
http_code | number | string
|
message | stringExplication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code |
reason | null | string | number | boolean | Array<n’importe quelle valeur> | objectN’importe lequel des schémas suivants peut s’appliquer : nullstringnumberbooleanArray<n’importe quelle valeur>Array<n’importe quelle valeur>Schéma d’un élément de tableaun’importe quelle valeurobjectobjectSchéma de la propriété supplémentairen’importe quelle valeur |
HTTP 400
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "TEMPLATE_VALIDATION_ERROR"
La validation de votre Template a échoué.
La réponse peut contenir des champs supplémentaires.