rendercarbonecloudtemplate - Render Carbone Cloud Template
Renders a carbone clooud template by a given ID with specified data. Requires a Carbone Cloud API key.
apiKey
string
Your carbone.io API Key.
Example:
yourApiKey
templateId
string
Your carbone.io template ID.
Example:
590c9afdfaafceca2133937b4939aaa554d828c4de0e6fc1e00427813238dbcf
data
object
Data to fill your template with. Either data or stringified data needs to be provided.
Example:
{
"companyName": "JohnInsurance & Co",
"period": 2,
"sD": 1659041229,
"id": 2891,
"insured": {
"name": "Jean Michel",
"street": "23, Sycamore Street",
"city": "New York",
"phone": "+33 2 38 99 18 23"
},
"showPropertyDamage": false,
"propertyDamage": [
{
"type": "Fire"
},
{
"type": "Wind"
},
{
"type": "Hail"
},
{
"type": "Water"
}
],
"options": [
{
"type": "Furniture",
"note": "/",
"cost": 1200
},
{
"type": "Appliances",
"note": "/",
"cost": 400
},
{
"type": "Clothing",
"note": "/",
"cost": 300
},
{
"type": "Dishes",
"note": "in some cases",
"cost": 300
}
],
"optionsTotalHT": 2200,
"optionsTaxes": 10,
"optionsTotal": 2420
}
stringifiedData
string
Stringified data to fill your template with.
Example:
{"companyName":"JohnInsurance & Co","period":2,"sD":1659041229,"id":2891,"insured":{"name":"Jean Michel","street":"23, Sycamore Street","city":"New York","phone":"+33 2 38 99 18 23"},"showPropertyDamage":false,"propertyDamage":[{"type":"Fire"},{"type":"Wind"},{"type":"Hail"},{"type":"Water"}],"options":[{"type":"Furniture","note":"/","cost":1200},{"type":"Appliances","note":"/","cost":400},{"type":"Clothing","note":"/","cost":300},{"type":"Dishes","note":"in some cases","cost":300}],"optionsTotalHT":2200,"optionsTaxes":10,"optionsTotal":2420}
outputFormat
string
Output format for your rendered template. Defaults to pdf.
Possible values are: pdf, xslx, docx, ods, csv, txt, odt
Example:
pdf