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를 여기에 연결하세요. 그러면 연동을 망가뜨리는 템플릿 변경이 고객이 받는 혼란스러운 이메일이 아니라 실패한 테스트로 드러납니다.

발송이 엄격한 지점에서 이쪽은 관대합니다. 필수 prop이 빠져도 거부되지 않고 warnings에 보고되는데, 미리보기 중인 템플릿은 대개 작성 중인 템플릿이기 때문입니다. 반면 선언되지 않은 prop은 여기서도 422입니다. 오타는 어느 단계에서든 오타이기 때문입니다.

초안도 미리볼 수 있으며, 게시 외에 무언가를 렌더링하는 경로는 이것뿐입니다. version을 생략하면 게시된 것을 미리보고, 특정 버전을 지정하면 초안을 포함해 그 리비전을 미리봅니다.

응답은 JSON이며 text/html이 아닙니다. HTML은 필드에 담긴 문자열이므로, 클라이언트는 무엇을 할지 정하기 전에 응답을 파싱할 수 있습니다.