E-posta şablonunu önizle

POST /v1/email-templates/{family}/{locale}:preview · izin email-templates:write · Startup planı ve üstü

Kaydedilmiş bir sürümü ya da henüz kaydetmediğiniz içeriği örnek verilerle render eder ve alıcıların göreceği tam iletiyi döndürür: platform düzeni, zorunlu güvenlik bloğu ve platform işareti. Hiçbir şey kaydedilmez ya da gönderilmez. Örnek kod ve bağlantı her çağrıda rastgele üretilir. Doğrulama, taslak kaydetmekle aynıdır.

Yol parametreleri

Parametre Açıklama
family E-posta ailesi, örneğin verify_email veya email_otp (E-posta şablonlarını listele bölümüne bakın).
locale Dil etiketi, örneğin en veya de.

İstek

Ya version ya da içerik alanlarını gönderin, ikisini birden değil.

Alan Tür Açıklama
version integer Render edilecek kayıtlı bir sürüm (1 veya daha büyük).
subject, html, text_body, from_name string Kaydedilmemiş içerik; taslak kaydetme ile aynı kurallar geçerlidir.

Yanıt

200 OK

{
  "subject": "Confirm your email for Example App",
  "html": "<!doctype html><html lang=\"en\">…</html>",
  "text": "Confirm your email: https://login.example.com/preview/9f2c…",
  "locale": "en"
}

locale, platformun kendi bölümleri için kullanılan katalog dilidir.

Hatalar

HTTP code Ne zaman
400 unknown_field Gövdede bilinmeyen bir alan var ya da gövde bir JSON nesnesi değil.
404 not_found Aile ya da dil bilinmiyor veya sürüm mevcut değil.
403 plan_feature_unavailable Ortamın planı özel e-posta şablonlarını içermiyor (Startup ve üstü; hangisinin gerektiği required_plan alanında yazar).
413 payload_too_large Gövde 2 MiB'den büyük.
422 validation_failed Hem version hem içerik gönderildi (conflicts_with_content) ya da içerik doğrulamayı geçemiyor.
422 template_forbidden_construct Şablon sandbox dışında bir Liquid yapısı kullanıyor.
401 unauthenticated Kimlik bilgisi eksik, geçersiz ya da iptal edilmiş.
403 insufficient_permissions Kimlik bilgisinin gerekli izni yok.
429 rate_limited Hız sınırı aşıldı; Retry-After süresinden sonra yeniden deneyin.
503 service_unavailable Bir bağımlılık geçici olarak kullanılamıyor; Retry-After süresinden sonra yeniden deneyin.

Örnek

curl -X POST https://api.eu.keenauth.com/v1/email-templates/verify_email/en:preview \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":3}'

CLI: keenauth email-templates preview verify_email en --version 3