Przejdź do dokumentacji
API

Podejrzyj szablon

Dokładnie ten HTML, który wyprodukowałaby wysyłka, bez wysyłania go.

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

Uruchamia prawdziwe wywołanie na twojej przestrzeni roboczej, twoim własnym kluczem.

POST /templates/{id}/preview

Dokładnie ten HTML, który wyprodukowałaby wysyłka, bez wysyłania go.

Przykład

Wymaga templates:read. POST, bo wartości idą w ciele żądania; nic nie jest zapisywane i nic nie jest wysyłane.

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

Skieruj tu swoje CI. Zmiana szablonu, która psuje twoją integrację, staje się wtedy nieudanym testem, a nie mylącym e-mailem u klienta.

Pobłażliwe tam, gdzie wysyłka jest surowa: brak wymaganego propa jest zgłaszany w warnings, a nie odrzucany, bo szablon, który się podgląda, to zwykle szablon, który się właśnie pisze. NIEZNANY prop to nadal 422, bo literówka jest literówką na każdym etapie.

Wersję roboczą można podejrzeć i to jedyna ścieżka, która renderuje cokolwiek poza publikacją. Pomiń version, a podejrzysz to, co jest opublikowane; wskaż ją, by podejrzeć tę rewizję, wersje robocze włącznie.

JSON, nigdy text/html. HTML jest stringiem w polu, żeby klient mógł sparsować odpowiedź, zanim zdecyduje, co z nią zrobić.