Cloud Outbound Mailer 개요

개요

Cloud Outbound Mailer API는 RESTful 형태로 제공됩니다. HTTP 방식의 GET/POST/DELETE 메서드 호출을 통해서 이루어집니다.
API를 통해 주소록을 구성/관리하고 메일 발송을 요청하며 요청 결과를 확인하고 발송 이력을 조회할 수 있습니다.

공통 설정

Cloud Outbound Mailer API Endpoint

요청 헤더

인증 헤더

Cloud Outbound Mailer API는 NAVER Cloud Platform API Gateway를 통하여 제공되며, API Gateway에 등록된 API를 사용하기 위해서는 2가지 인증키(Access Key ID, Secret Key)를 발급받아야 합니다

자세한 내용은 NAVER CLOUD PLATFORM API 가이드를 참고 부탁드립니다.

• 인증키 생성
  • NAVER Cloud Platform 포털의 마이페이지 > 계정관리 > 인증키 관리 메뉴에서 신규 API 인증키 생성을 클릭하여 Access Key ID, Secret Key를 생성합니다
  • 만약 Access Key ID, Secret Key가 있다면 해당 키를 사용합니다.

요청 예시

curl -i -s -X POST \
 -H "Content-Type:application/json" \
 -H "x-ncp-apigw-timestamp:1521787414578" \
 -H "x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy" \
 -H "x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=" \
 "https://mail.apigw.ntruss.com/api/v1/mails"\
 -d '{"senderAddress":"no_reply@company.com","title":"${customer_name}님 반갑습니다. ","body":"귀하의 등급이 ${BEFORE_GRADE}에서 ${AFTER_GRADE}로 변경되었습니다.","recipients":[{"address":"hongildong@naver_.com","name":"홍길동","type":"R","parameters":{"customer_name":"홍길동","BEFORE_GRADE":"SILVER","AFTER_GRADE":"GOLD"}},{"address":"chulsoo@daum_.net","name":null,"type":"R","parameters":{"customer_name":"철수","BEFORE_GRADE":"BRONZE","AFTER_GRADE":"SILVER"}}],"individual":true,"advertising":false}'

• Signature 생성(개행 문자는 \n을 사용)

  • 요청에 맞게 StringToSign을 생성하고 SecretKey로 HmacSHA256 알고리즘으로 암호화한 후 Base64로 인코딩합니다
  • 이 값을 x-ncp-apigw-signature-v2로 사용합니다.

• 샘플 코드

public String makeSignature() {
    String space = " ";  // 공백
    String newLine = "\n";  // 줄바꿈
    String method = "POST";  // HTTP 메소드
    String url = "/api/v1/mails";  // 도메인을 제외한 "/" 아래 전체 url (쿼리스트링 포함)
    String timestamp = "{timestamp}";  // 현재 타임스탬프 (epoch, millisecond)
    String accessKey = "{accessKey}";  // access key id (from portal or sub account)
    String secretKey = "{secretKey}";  // secret key (from portal or sub account)

    String message = new StringBuilder()
        .append(method)
        .append(space)
        .append(url)
        .append(newLine)
        .append(timestamp)
        .append(newLine)
        .append(accessKey)
        .toString();

    SecretKeySpec signingKey = new SecretKeySpec(secretKey.getBytes("UTF-8"), "HmacSHA256");
    Mac mac = Mac.getInstance("HmacSHA256");
    mac.init(signingKey);

    byte[] rawHmac = mac.doFinal(message.getBytes("UTF-8"));
    String encodeBase64String = Base64.getEncoder().encodeToString(rawHmac);

  return encodeBase64String;

}

function makeSignature() {
    $space = " ";  // 공백
    $newLine = "\n";  // 줄바꿈
    $method = "POST";  // HTTP 메소드
    $uri= "/api/v1/mails";  // 도메인을 제외한 "/" 아래 전체 url (쿼리스트링 포함)
    $timestamp = "{timestamp}";  // 현재 타임스탬프 (epoch, millisecond)
    $accessKey = "{accessKey}";  // access key id (from portal or sub account)
    $secretKey = "{secretKey}";  // secret key (from portal or sub account)
    
    $hmac = $method.$space.$uri.$newLine.$timestamp.$newLine.$accessKey;
    $signautue = base64_encode(hash_hmac('sha256', $hmac, $secretKey,true));
    
    return $signautue;
}

공통 응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.

오퍼레이션

이메일 발송

• createMailRequest
• getMail
• getMailList
• getMailRequestList
• getMailRequestStatus
• createFile
• getFile
• deleteFile

템플릿 관리

• createTemplate
• createTemplateExportRequest
• getTemplate
• getTemplateExportRequestList
• getTemplateStructure
• updateTemplate
• updateTemplateLocationOrName
• exportTemplate
• importTemplate
• deleteTemplate
• restoreTemplate
• createCategory
• updateCategory
• deleteCategory

수신자 그룹 관리

• createAddressBook
• getAddressBook
• deleteAddressBook
• deleteAddress
• deleteRecipientGroup
• deleteRecipientGroupRelation
• deleteRecipientGroupRelationEmpty

발송 차단 및 수신 거부 관리

• getSendBlockList
• registerUnsubscribers
• getUnsubscribersList
• deleteUnsubscribers

프로젝트 설정 관리

• createConfig
• getConfig