تخطَّ إلى المستندات
API

معاينة قالب

الـ HTML نفسه الذي كان الإرسال سينتجه، دون إرساله.

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

ينفّذ الاستدعاء الحقيقي على مساحة عملك، بمفتاحك أنت.

POST /templates/{id}/preview

الـ HTML نفسه الذي كان الإرسال سينتجه، دون إرساله.

مثال

يتطلب templates:read. وهو POST لأن القيم تذهب في متن الطلب؛ ولا يُكتب شيء ولا يُرسل شيء.

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) إلى هذا. فتغيير القالب الذي يكسر تكاملك يصير عندئذٍ اختباراً فاشلاً لا بريداً محيّراً يصل إلى عميل.

متساهل حيث يتشدّد الإرسال: فالخاصية المطلوبة الغائبة تُبلَّغ في warnings بدل أن تُرفض، لأن القالب الذي يُعاين هو غالباً قالب قيد الكتابة. أما الخاصية المجهولة فتبقى 422 هنا، لأن الخطأ المطبعي خطأ مطبعي في كل مرحلة.

يمكن معاينة المسوّدة، وهذا المسار الوحيد الذي يعرض شيئاً خارج النشر. أغفِل version فتعاين ما هو منشور؛ وسمِّ واحداً لتعاين تلك المراجعة، بما فيها المسوّدة.

JSON، ولا يكون text/html أبداً. فالـ HTML سلسلة نصية داخل حقل حتى يتمكّن العميل من تحليل الاستجابة قبل أن يقرّر ما يفعله بها.