เริ่มต้นที่นี่

เริ่มต้นอย่างรวดเร็ว

สร้างคีย์ ยืนยันโดเมน และส่งอีเมลแบบควบคุมด้วยคำขอที่ลองใหม่ได้อย่างปลอดภัย

ก่อนเริ่มต้น

สร้างเวิร์กสเปซ SendHQ และเปิดแดชบอร์ดค้างไว้ เวิร์กสเปซใหม่จะได้รับช่วงทดลองการเชื่อมต่อแบบควบคุม คือส่งถึงได้เฉพาะอีเมลของบัญชีหรือที่อยู่จำลองของ AWS SES จนกว่าจะเปิดใช้การสมัครแบบชำระเงิน

1. สร้าง API key

เปิด API keys ในแดชบอร์ด เลือกชื่อที่สื่อความหมาย เช่น Production และคัดลอกคีย์เมื่อแสดงขึ้นมา เก็บไว้ในตัวจัดการความลับฝั่งเซิร์ฟเวอร์ SendHQ จะไม่แสดงค่าเต็มอีก

.env
SENDHQ_API_KEY=re_your_key_here

2. เพิ่มโดเมนผู้ส่ง

เปิด Domains เพิ่มโดเมนที่คุณควบคุม และเผยแพร่เรคคอร์ด DKIM, SPF, DMARC และการยืนยัน SES ที่ระบบส่งคืนมา ผู้ใช้ Cloudflare อนุญาตการตั้งค่า DNS แบบครั้งเดียวได้ SendHQ จะทิ้งโทเค็น OAuth หลัง callback

อย่าเผยแพร่นโยบาย SPF ที่สองหากมี SPF อยู่แล้ว ให้รวม include:amazonses.com เข้ากับค่า v=spf1 ที่มีอยู่

3. รอการยืนยัน

ใช้แดชบอร์ดหรือ POST /domains/:id/verify DNS อาจผ่านสถานะ pending, checking และ propagating ก่อนที่ SES จะรายงานตัวตนเป็น verified

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."}'

คำขอที่สำเร็จจะคืน ID อีเมลของ SendHQ ID ข้อความของผู้ให้บริการ และ ID เธรดของบทสนทนา เก็บ ID ของ SendHQ ไว้พร้อมกับอีเวนต์ของแอปพลิเคชันที่ทำให้เกิดอีเมลนั้น

5. จัดการผลลัพธ์

คำขอ API ที่ถูกยอมรับไม่เหมือนกับการส่งถึงผู้รับ ดึง /emails/:id/events หรือใช้แดชบอร์ดเพื่อตรวจสอบอีเวนต์ delivery, bounce, complaint, reject, open และ click