दस्तावेज़ पर जाएँ
API

टेम्पलेट का पूर्वावलोकन करें

ठीक वही HTML जो एक send बनाता, बिना उसे भेजे।

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

असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

POST /templates/{id}/preview

ठीक वही HTML जो एक send बनाता, बिना उसे भेजे।

उदाहरण

templates:read चाहिए। POST इसलिए कि मान body में जाते हैं; कुछ लिखा नहीं जाता और कुछ भेजा नहीं जाता।

curl
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" }]}

अपनी CI इसी पर लगाएँ। तब टेम्पलेट का वह बदलाव जो आपके इंटीग्रेशन को तोड़ता है, ग्राहक का उलझाऊ ईमेल नहीं बल्कि एक फेल होता टेस्ट बन जाता है।

जहाँ send सख़्त है वहाँ यह नरम है: ग़ायब आवश्यक prop को अस्वीकार करने के बजाय warnings में बताया जाता है, क्योंकि पूर्वावलोकन किया जा रहा टेम्पलेट आमतौर पर लिखा जा रहा टेम्पलेट होता है। अनजान prop यहाँ भी 422 है, क्योंकि टाइपो हर चरण पर टाइपो ही है।

ड्राफ़्ट का पूर्वावलोकन किया जा सकता है, और प्रकाशन के बाहर कुछ भी रेंडर करने वाला यही एकमात्र रास्ता है। version छोड़ दें तो आप वह देखते हैं जो प्रकाशित है; किसी एक का नाम लें तो उस रिवीज़न का, ड्राफ़्ट सहित।

JSON, कभी text/html नहीं। HTML एक फ़ील्ड में string है ताकि क्लाइंट यह तय करने से पहले प्रतिक्रिया पार्स कर सके कि उसका क्या करना है।