Previsualitzar una plantilla
Exactament l'HTML que produiria un enviament, sense enviar-lo.
Executa la crida real contra el teu espai de treball, amb la teva pròpia clau.
POST /templates/{id}/preview
Exactament l'HTML que produiria un enviament, sense enviar-lo.
Exemple
Necessita templates:read. Un POST perquè els valors van en un cos; no s'escriu res i no s'envia res.
curl -X POST "$OE/templates/order-shipped/preview" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "version": 5, "props": { "orderId": "AC-4192" } }'{ "object": "template_preview", "templateId": "tpl_9c1f0a4b7e05d3862c1f0a44", "version": 5, "subject": "Order AC-4192 is on its way", "html": "<!DOCTYPE html><html>…</html>", "text": "Hello there, AC-4192 is on its way.", "warnings": [{ "code": "unfilled_placeholder", "key": "customer" }]}Apunta-hi la teva CI. Així, un canvi de plantilla que trenqui la teva integració és una prova que falla i no pas un correu confús per a un client.
Indulgent allà on un enviament és estricte: una prop obligatòria que falti s'informa a warnings en comptes de rebutjar-se, perquè una plantilla que es previsualitza sol ser una plantilla que s'està escrivint. Una prop DESCONEGUDA continua sent un 422 aquí, perquè una errada d'escriptura és una errada en qualsevol etapa.
Un esborrany es pot previsualitzar, i aquest és l'únic camí que renderitza res fora de la publicació. Omet version i previsualitzes el que està publicat; indica'n una per previsualitzar aquella revisió, esborrany inclòs.
JSON, mai text/html. L'HTML és una cadena dins d'un camp perquè un client pugui analitzar la resposta abans de decidir què en fa.