Cloud Outbound Mailerの概要

概要

Cloud Outbound Mailer APIは RESTfulの形式で提供されます。HTTP方式の GET/POST/DELETEメソッドの呼び出しを介して行われます。
APIを使用してアドレス帳を構成/管理してメールの送信をリクエストし、リクエスト結果を確認して送信履歴を照会することができます。

共通設定

Cloud Outbound Mailer API Endpoint

リクエストヘッダ

認証ヘッダ

Cloud Outbound Mailer APIは NAVERクラウドプラットフォーム API Gatewayを介して提供されます。API Gatewayに登録されている APIを使用するには、2つの認証キー(Access Key ID、Secret Key)の発行が必要です。

詳細は、NAVERクラウドプラットフォーム APIガイドをご参照ください。

• 認証キーを作成
  • Ncloud 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ステータスコードで返され、ボディ情報として伝達する。

オペレーション

メールの送信

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

テンプレートの管理

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

受信者グループの管理

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

送信遮断および受信拒否の管理

• getSendBlockList
• registerUnsubscribers
• deleteUnsubscribers