Bỏ qua tới phần tài liệu
API

Xem trước một template

Chính xác phần HTML mà một lần gửi sẽ tạo ra, nhưng không gửi đi.

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

Chạy lệnh gọi thật với không gian làm việc của bạn, bằng khóa của chính bạn.

POST /templates/{id}/preview

Chính xác phần HTML mà một lần gửi sẽ tạo ra, nhưng không gửi đi.

Ví dụ

Cần templates:read. Là POST vì các giá trị nằm trong body; không có gì được ghi và không có gì được gửi.

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

Hãy trỏ CI của bạn vào đây. Khi đó, một thay đổi template làm hỏng tích hợp của bạn sẽ là một bài test thất bại chứ không phải một email khó hiểu gửi tới khách hàng.

Dễ dãi ở chỗ lần gửi nghiêm ngặt: một prop bắt buộc bị thiếu được báo trong warnings thay vì bị từ chối, vì một template đang được xem trước thường là một template đang được viết. Một prop KHÔNG XÁC ĐỊNH vẫn là 422 ở đây, vì lỗi gõ nhầm là lỗi gõ nhầm ở mọi giai đoạn.

Một bản nháp có thể xem trước, và đây là con đường duy nhất render bất cứ thứ gì ngoài lúc xuất bản. Bỏ trống version thì bạn xem trước bản đang được xuất bản; nêu một phiên bản để xem trước bản sửa đổi đó, kể cả bản nháp.

JSON, không bao giờ là text/html. Phần HTML là một chuỗi trong một trường để client có thể parse phản hồi trước khi quyết định làm gì với nó.