Sablon előnézete
Pontosan az a HTML, amelyet egy küldés előállítana, anélkül hogy elküldenéd.
A valódi hívást futtatja le a munkaterületén, a saját kulcsával.
POST /templates/{id}/preview
Pontosan az a HTML, amelyet egy küldés előállítana, anélkül hogy elküldenéd.
Példa
templates:read szükséges hozzá. Azért POST, mert az értékek a törzsbe kerülnek; semmi nem íródik és semmi nem megy ki.
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" }]}Irányítsd ide a CI-t. Az integrációdat megtörő sablonváltozás így egy elbukó teszt lesz, nem pedig egy ügyfél zavarba ejtő e-mailje.
Elnézőbb ott, ahol a küldés szigorú: a hiányzó kötelező prop a warnings közt jelenik meg, nem elutasításként, mert az előnézetben nézett sablon rendszerint éppen íródik. Az ISMERETLEN prop itt is 422, mert az elgépelés minden szakaszban elgépelés.
A piszkozat előnézete megtekinthető, és ez az egyetlen út, amely közzétételen kívül bármit is renderel. Hagyd ki a version mezőt, és azt nézed meg, ami közzé van téve; nevezz meg egyet, és azt a változatot nézed meg, a piszkozatot is beleértve.
JSON, soha nem text/html. A HTML egy mezőben lévő string, hogy a kliens feldolgozhassa a választ, mielőtt eldöntené, mit kezdjen vele.