Belgelere geç
API

Bir şablonu önizle

Bir gönderimin üreteceği HTML'in tam olarak kendisi, göndermeden.

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

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

POST /templates/{id}/preview

Bir gönderimin üreteceği HTML'in tam olarak kendisi, göndermeden.

Örnek

templates:read gerekir. Değerler gövdede gittiği için POST'tur; hiçbir şey yazılmaz ve hiçbir şey gönderilmez.

curl
curl -X POST "$OE/templates/order-shipped/preview" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "version": 5, "props": { "orderId": "AC-4192" } }'
Yanıt
{  "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'nızı buraya yöneltin. Entegrasyonunuzu bozan bir şablon değişikliği, böylece bir müşterinin kafa karıştıran e-postası değil, başarısız bir test olur.

Gönderimin katı olduğu yerde hoşgörülüdür: eksik bir zorunlu prop reddedilmek yerine warnings içinde bildirilir; çünkü önizlenen bir şablon genellikle yazılmakta olan bir şablondur. BİLİNMEYEN bir prop burada da 422'dir; çünkü bir yazım hatası her aşamada yazım hatasıdır.

Bir taslak önizlenebilir ve bu, yayımlama dışında herhangi bir şeyi render eden tek yoldur. version vermeyin, yayımlanmış olanı önizlersiniz; bir tane adlandırın, taslak dahil o revizyonu önizlersiniz.

JSON, asla text/html değil. HTML bir alanın içinde dizedir ki istemci, onunla ne yapacağına karar vermeden önce yanıtı ayrıştırabilsin.