Náhled šablony
Přesně to HTML, které by odeslání vyprodukovalo, aniž by se odeslalo.
Spustí skutečné volání proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.
POST /templates/{id}/preview
Přesně to HTML, které by odeslání vyprodukovalo, aniž by se odeslalo.
Příklad
Vyžaduje templates:read. POST proto, že hodnoty jdou v těle; nic se nezapisuje a nic se neodesílá.
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" }]}Namiřte na to své CI. Změna šablony, která rozbije vaši integraci, je pak padající test, a ne matoucí e-mail pro zákazníka.
Shovívavý tam, kde je odeslání přísné: chybějící povinný prop se hlásí ve warnings, místo aby byl odmítnut, protože šablona v náhledu je obvykle šablona, která se právě píše. NEZNÁMÝ prop je tu ale pořád 422, protože překlep je překlep v každé fázi.
Koncept lze zobrazit v náhledu a toto je jediná cesta, která vykreslí něco mimo publikování. Vynechte version a uvidíte náhled toho, co je publikováno; uveďte ji a uvidíte náhled dané revize, včetně konceptu.
JSON, nikdy text/html. HTML je řetězec v poli, aby klient mohl odpověď naparsovat dřív, než se rozhodne, co s ní.