Champs du corps de la requête :
template
object
Requis
Le template de la vidéo à générer
template.id
number
Requis
L'id du template de la vidéo à générer
template.formats
string | array
Optionnel
Les formats de vidéos à générer (string "all", "html5", "{width}x{height}" ou un tableau de formats excluant "all")
template.html_max_size_kb
int
Optionnel
Définie la taille cible de la vidéo html, plus la taille est faible et plus la vidéo sera compressé (1999 par défaut)
template.click_links
object | string
Optionnel
Url des cliques du template (string s'il n'y a qu'un seul clique ou un objet contenant les cliques s'il y en a plusieurs, le nombre d'url doit être égale au nombre de clique du template)
template.click_links.ClickHTMLX
string
Optionnel
Url du clique "X" du template de la vidéo à générer
video_name
string
Requis
Nom de la vidéo qui sera généré
webhook
string
Optionnel
URL d'un webhook. Une requête POST sera envoyée sur cette URL lors de la fin d'excécution d'un job. La requête POST contiendra les mêmes données que celles fournies lors d’un GET status.
Les autres paramètres représenteront la valeur des champs à remplacer sur le template préalablement mapper, tous les champs à remplacer sont requis.
Requête :
"template": {
"id": 3,
"formats": [
"html5",
"1920x1080"
],
"html_max_size_kb": 1000,
"click_links": {
"ClickHTML1": "https://www.google.com",
"ClickHTML2": "https://www.google.com",
"ClickHTML3": "https://www.google.com",
"ClickHTML4": "https://www.google.com"
}
},
"webhook": "https://webhook.site/3a383131-2f94-49b8-8dc0-4b3369a2d16b",
"video_name": "video_test_3Produits",
"campaign": {
"campaignTechTitle": "",
"campaignTitle": "Nom de\rl’opération",
"campaignMainImage": "",
"campaignDate": "Du 16 au 19 décembre 2022",
"campaignImageLogoRetailer": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/Logo.png",
"campaignNameRetailer": "Test local repiq test",
"campaignAdressRetailer": ""
},
"products": [
{
"productImageMacaronPromo1": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/Ecouteurs prix.png",
"productImageMacaronPromo2": "",
"productImageMacaronPromo3": "",
"productInitialPriceUnit": "0.0",
"productInitialPriceDecimal": "0.0",
"productDiscountedPriceUnit": "00",
"productDiscountedPriceDecimal": ".00",
"productPromoType": "",
"productPromoLabel": "",
"productPromoDiscountAmount": "00",
"productPromoDiscountPercentage": "00",
"productTitle": "Nom produit 1",
"productBrand": "MARQUE 1",
"productDescription1": "Description produit1\rDescription produit1\rDescription produit1\rDescription produit1",
"productDescription2": "",
"productDescription3": "",
"productLegalNotice": "",
"productMainImage": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/07613035009301-a1l1-s58-removebg-preview.png",
"productImage": "",
"productPicto": "",
"productLogo": "",
"productCategory": "",
"productSubCategory": "",
"productMandateStartDate": "",
"productMandateEndDate": "",
"productEcommerceURL": "",
"productEcatalogURL": "",
"productContentPatternURL": ""
},
{
"productImageMacaronPromo1": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/Frites prix.png",
"productImageMacaronPromo2": "",
"productImageMacaronPromo3": "",
"productInitialPriceUnit": "0.0",
"productInitialPriceDecimal": "0.0",
"productDiscountedPriceUnit": "00",
"productDiscountedPriceDecimal": ".00",
"productPromoType": "",
"productPromoLabel": "",
"productPromoDiscountAmount": "00",
"productPromoDiscountPercentage": "00",
"productTitle": "Nom produit 2",
"productBrand": "MARQUE 2",
"productDescription1": "Description produit2\rDescription produit2\rDescription produit2\rDescription produit2",
"productDescription2": "",
"productDescription3": "",
"productLegalNotice": "",
"productMainImage": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/3560070369690-0-removebg-preview.png",
"productImage": "",
"productPicto": "",
"productLogo": "",
"productCategory": "",
"productSubCategory": "",
"productMandateStartDate": "",
"productMandateEndDate": "",
"productEcommerceURL": "",
"productEcatalogURL": "",
"productContentPatternURL": ""
},
{
"productImageMacaronPromo1": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/Lessive Prix.png",
"productImageMacaronPromo2": "",
"productImageMacaronPromo3": "",
"productInitialPriceUnit": "0.0",
"productInitialPriceDecimal": "0.0",
"productDiscountedPriceUnit": "00",
"productDiscountedPriceDecimal": ".00",
"productPromoType": "",
"productPromoLabel": "",
"productPromoDiscountAmount": "00",
"productPromoDiscountPercentage": "00",
"productTitle": "Nom produit 3",
"productBrand": "MARQUE 3",
"productDescription1": "Description produit3\rDescription produit3\rDescription produit3\rDescription produit3",
"productDescription2": "",
"productDescription3": "",
"productLegalNotice": "",
"productMainImage": "s3://clip-it-dev-customer.s3.amazonaws.com/test/Compo - 3 produits/sources/03252210490110-h1l1-s02-removebg-preview.png",
"productImage": "",
"productPicto": "",
"productLogo": "",
"productCategory": "",
"productSubCategory": "",
"productMandateStartDate": "",
"productMandateEndDate": "",
"productEcommerceURL": "",
"productEcatalogURL": "",
"productContentPatternURL": ""
}
]
}
Réponse :
{
"uid": "string",
"state": "string",
"format": "string",
"child_jobs": [
{
"uid": "string",
"state": "string",
"format": "string",
"video_s3_path": "string",
"after_project_path": "string"
}
],
"video_s3_path": "string",
"after_project_path": "string",
"video_name": "string",
"renderProgress": 0,
"error": {},
"createdAt": "string",
"startedAt": "string",
"finishedAt": "string"
}
.svg)