はじめに

クイックスタート

APIキーを作成し、ドメインを検証して、再試行しても安全なリクエストで制御されたメールを送信します。

始める前に

SendHQのワークスペースを作成し、ダッシュボードを開いたままにしておきます。新しいワークスペースには制限付きの連携トライアルが適用されます。有料サブスクリプションが有効になるまで、配信先はアカウントのメールアドレスまたはAWS SESシミュレーターのアドレスに限られます。

1. APIキーを作成する

ダッシュボードでAPIキーを開き、Productionなどのわかりやすい名前を付けて、表示されたキーをコピーします。キーはサーバー側のシークレットマネージャーに保存してください。SendHQが完全な値を再び表示することはありません。

.env

SENDHQ_API_KEY=re_your_key_here

2. 送信ドメインを追加する

ドメインを開き、管理しているドメインを追加して、表示されたDKIM、SPF、DMARC、SES検証用のレコードを公開します。Cloudflareのユーザーは1回限りのDNS設定を承認できます。SendHQはコールバック後にOAuthトークンを破棄します。

SPFポリシーを2つ公開しないでください。SPFがすでに存在する場合は、既存のv=spf1の値にinclude:amazonses.comを統合してください。

3. 検証を待つ

ダッシュボードまたはPOST /domains/:id/verifyを使います。SESがIDをverifiedと報告するまでに、DNSはpending、checking、propagatingの各状態を経ることがあります。

4. 制御されたメッセージを送信する

curl

curl https://sendhq.cc/api/v1/emails \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onboarding-user-42" \
  -d '{"from":"Acme <hello@example.com>","to":["owner@example.com"],"subject":"SendHQ is connected","html":"<h1>It works</h1><p>Your first controlled message was accepted.</p>","text":"It works. Your first controlled message was accepted."}'

リクエストが成功すると、SendHQのメールID、プロバイダーのメッセージID、会話のスレッドIDが返されます。SendHQのIDは、メール送信のきっかけとなったアプリケーションイベントと一緒に保存してください。

5. 結果を処理する

APIリクエストが受け付けられたことは、受信者への配信とは同じではありません。/emails/:id/eventsを取得するかダッシュボードを使って、配信、バウンス、苦情、拒否、開封、クリックのイベントを確認してください。