자동 이메일 API 사용하기

자동 이메일을 API로 요청해서 발송할 수 있습니다.

자동 이메일에 대한 개념이 궁금하면 자동 이메일이 뭔가요?를 참고하세요.
자동 이메일을 만들고 발송하는 방법이 궁금하면 자동 이메일 만들기, 발송하기, 예약하기를 참고하세요.

자동 이메일을 API로 요청해서 발송한다는 것은, 스티비가 제공하는 API 엔드포인트로 POST 메소드로 요청하여, 미리 설정한 이메일을 발송한다는 의미입니다.

1. API 키 만들기

자동 이메일 API를 사용하려면 우선 스티비에서 API 키를 만들어야 합니다. API는 계정 단위로 관리되기 때문에 API 키의 생성과 관리는 모두 사용자 메뉴의 계정 > API 키에서 이루어집니다.

 

 

2. API 사용하기

계정 > API 키에서 API 키를 생성한 뒤, API 키 옆의 복사하기를 클릭하면 API 키를 복사할 수 있습니다. 이 키는 API 요청 시 토큰으로 사용됩니다.

 

 

API 키가 노출되면 스티비 계정 보안에 치명적인 문제가 생길 수 있으니 주의하세요. 만약 노출이 의심되면 계정 > API 키에서 해당 키를 비활성화하거나 삭제하고 새로운 키를 만드세요.

3. 자동 이메일 API 엔드포인트 확인하기

자동 이메일 발송 조건의 트리거를 "API로 요청하기"로 설정하면 자동 이메일 API의 Endpoint URL을 확인할 수 있습니다.

 

 

이 URL은 자동 이메일 대시보드에서도 확인할 수 있습니다.

 

 

4. 자동 이메일 API 요청 및 응답 모델

자동 이메일 API 요청 및 응답은 JSON 형식을 따릅니다. 예를 들어, 자동 이메일의 API 트리거를 실행하려면 POST Method로 다음과 같은 JSON 형식의 요청을 보냅니다.

HTTP Methods

• POST

Endpoint URL

• https://stibee.com/api/v1.0/auto/...

Header

• AccessToken: API 키
• Contnet-Type: application/json

Request Body

• subscriber: 자동 발송할 대상이 되는 구독자의 이메일 주소입니다.

5. 자동 이메일 API 요청 및 응답 예제

"user@domain.com"로 자동 이메일 발송을 할 경우, 다음과 같이 요청합니다.

POST https://stibee.com/api/v1.0/auto/...
{
    "subscriber": "user@domain.com"
}

이에 대한 응답은 다음과 같습니다.

200 OK

이 응답 값이 이메일 발송 성공, 실패를 의미하는 것은 아닙니다. 200 OK 응답이 왔더라도 이메일 발송은 실패할 수 있습니다. 이메일 발송 성공, 실패 결과는 이메일의 상세 통계 화면에서 확인할 수 있습니다. 이메일 발송 실패에 대한 자세한 내용은 발송을 완료했는데 이메일이 도착하지 않습니다를 참고하세요.

응답 결과와 상관없이 "user@domain.com"이 자동 이메일의 주소록에 포함되어있지 않거나 수신거부, 자동삭제된 구독자라면, 트리거가 실행되지 않습니다.

6. 자동 이메일 API에서 사용자 정의 필드 사용하기

자동 이메일 API로 이메일 발송을 요청할 때, 이메일 주소 외에도 다른 값을 전송할 수 있습니다.

이렇게 하면 자동 이메일에서도 제목에 구독자 이름을 넣거나, 본문에 고객마다 다른 값(예. 적립금, 구매한 상품 이름 등)을 표시할 수 있습니다.

자동 이메일 API에서 이메일 주소 외 다른 값을 넣어 요청하는 방법은 다음과 같습니다.

POST https://stibee.com/api/v1.0/auto/...
{
    "subscriber": "user@domain.com"
    "key1": "value1",
    "key2": "value2",
    ...
}

이메일 제목이나 미리보기 텍스트, 이메일 본문에서 "$%key1%$", "$%key2%$"의 형식으로 사용자 정의 필드를 입력하면, 이메일이 발송될 때 key1, key2에 해당하는 값으로 치환되어 발송됩니다.

사용자 정의 필드 값 내 HTML 코드 사용

이메일 본문이 HTML로 구성되기 때문에 치환하는 값 안에 <br> 태그 외의 다른 HTML 태그를 사용하는 것도 가능하지만, 이렇게 사용된 태그에 대해 스티비에서 호환성을 보장하지는 않습니다. 예를 들어, 태그가 이메일 수신 환경에서 동작하지 않거나, 특정 태그로 인해 레이아웃이 깨질 수도 있습니다.

치환하는 값 안에서 줄바꿈을 하려면 HTML 태그 중 <br> 태그를 사용하면 됩니다. 예를 들어 자동 이메일 API 요청을 다음과 같이 했다고 가정해보겠습니다.

POST https://stibee.com/api/v1.0/auto/...
{
"subscriber": "user@domain.com"
"key1": "안녕하세요!<br>스티비 팀입니다.",
...
}

이메일 본문에 "$%key1%$"라는 텍스트가 포함되어있다면 이메일이 발송될 때 이렇게 치환되어 발송됩니다.

발송하기 전 이메일 본문 원본(치환 전)

...
$%key1%$
...

발송된 이메일 본문(치환 후)

...
안녕하세요!
스티비 팀입니다.
...

주소록의 사용자 정의 필드와의 관계

자동 이메일 API에서 사용되는 사용자 정의 필드는, 주소록의 사용자 정의 필드와 서로 영향을 주지 않으며, 더 높은 우선순위를 갖습니다.

예를 들어, 주소록에 "hoyeol@slowalk.co.kr"라는 구독자가 있고, 이 구독자의 "name"이라는 사용자 정의 필드의 값이 "호열"이라고 가정해보겠습니다.

이 구독자에게 자동 이메일 API로 "name"이라는 사용자 정의 필드에 "학진"이라는 값을 넣어 발송 요청을 하면 어떻게 될까요?

1. 주소록의 사용자 정의 필드 값인 "호열"보다 자동 이메일 API의 사용자 정의 필드 값인 "학진"이 더 높은 우선순위를 갖습니다. 따라서, 발송되는 이메일에는 "학진"이라는 값이 표시됩니다.
2. 주소록의 사용자 정의 필드와 자동 이메일 API는 서로 영향을 주지 않기 때문에, 주소록의 "name"이라는 사용자 정의 필드의 값은 변경되지 않고 "호열"로 유지됩니다.

일반 이메일에서 사용자 정의 필드를 사용하는 방법은 이메일 제목에 구독자 이름을 넣을 수 있나요?를 참고하세요.