پیشنمایش یک قالب
دقیقاً همان HTML ای که یک ارسال تولید میکند، بدون اینکه ارسالی انجام شود.
فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا میکند.
POST /templates/{id}/preview
دقیقاً همان HTML ای که یک ارسال تولید میکند، بدون اینکه ارسالی انجام شود.
نمونه
نیازمند templates:read. از POST استفاده میشود چون مقادیر در بدنه میروند؛ چیزی نوشته و چیزی فرستاده نمیشود.
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 خود را به همین نقطه وصل کنید. آنگاه تغییر یک قالب که یکپارچهسازی شما را میشکند، بهجای ایمیلی گیجکننده برای مشتری، یک تست شکستخورده خواهد بود.
اینجا سختگیری کمتری از ارسال دارد: نبودِ یک prop الزامی بهجای رد شدن در warnings گزارش میشود، چون قالبی که پیشنمایش میگیرد معمولاً قالبی است که در حال نوشته شدن است. اما یک prop ناشناخته همچنان اینجا 422 است، چون غلط تایپی در هر مرحلهای غلط تایپی است.
پیشنویس را میتوان پیشنمایش کرد، و این تنها مسیری است که بیرون از انتشار چیزی را رندر میکند. اگر version را ندهید، نسخهٔ منتشرشده پیشنمایش میشود؛ اگر یکی را نام ببرید، همان بازنگری، از جمله پیشنویس، پیشنمایش میشود.
JSON، هرگز text/html. خود HTML رشتهای درون یک فیلد است تا کلاینت بتواند پیش از تصمیم دربارهٔ آن، پاسخ را تجزیه کند.