Pāriet uz dokumentāciju
API

Priekšskatīt veidni

Tieši tas HTML, ko radītu sūtīšana, to nenosūtot.

POSTapi.openemail.uk/templates/{id}/preview

Izpilda īstu izsaukumu pret jūsu darbvietu, ar jūsu paša atslēgu.

POST /templates/{id}/preview

Tieši tas HTML, ko radītu sūtīšana, to nenosūtot.

Piemērs

Nepieciešams templates:read. POST tāpēc, ka vērtības iet ķermenī; nekas netiek rakstīts un nekas netiek sūtīts.

curl
curl -X POST "$OE/templates/order-shipped/preview" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "version": 5, "props": { "orderId": "AC-4192" } }'
Atbilde
{  "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" }]}

Pavērsiet savu CI uz šo. Veidnes izmaiņa, kas salauž jūsu integrāciju, tad ir krītošs tests, nevis klienta mulsinoša vēstule.

Iecietīgs tur, kur sūtīšana ir strikta: trūkstošs obligāts prop tiek ziņots warnings, nevis atteikts, jo veidne, ko priekšskata, parasti ir veidne, ko raksta. NEZINĀMS prop arī šeit joprojām ir 422, jo drukas kļūda ir drukas kļūda jebkurā posmā.

Melnrakstu var priekšskatīt, un šis ir vienīgais ceļš, kas ārpus publicēšanas kaut ko atveido. Izlaidiet version, un jūs priekšskatāt publicēto; nosauciet vienu, lai priekšskatītu to revīziju, arī melnrakstu.

JSON, nekad text/html. HTML ir virkne laukā, lai klients varētu atbildi parsēt, pirms izlemj, ko ar to darīt.