시작하기

빠른 시작

키를 만들고, 도메인을 검증하고, 재시도해도 안전한 요청으로 통제된 이메일을 보냅니다.

시작하기 전에

SendHQ 워크스페이스를 만들고 대시보드를 열어 두세요. 새 워크스페이스에는 통제된 연동 체험판이 제공되며, 유료 구독이 활성화되기 전까지는 계정 이메일 또는 AWS SES 시뮬레이터 주소로만 전송할 수 있습니다.

1. API 키 만들기

대시보드에서 API keys를 열고 Production처럼 알아보기 쉬운 이름을 선택한 뒤, 키가 표시될 때 복사하세요. 서버 측 시크릿 관리자에 저장하세요. SendHQ는 전체 값을 다시 보여 주지 않습니다.

.env

SENDHQ_API_KEY=re_your_key_here

2. 발신 도메인 추가하기

Domains를 열고 직접 관리하는 도메인을 추가한 뒤, 반환된 DKIM, SPF, DMARC, SES 검증 레코드를 게시하세요. Cloudflare 사용자는 일회성 DNS 설정을 승인할 수 있으며, SendHQ는 콜백 이후 OAuth 토큰을 폐기합니다.

SPF 정책을 두 번째로 게시하지 마세요.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를 조회하거나 대시보드에서 전달, 반송, 스팸 신고, 거부, 열람, 클릭 이벤트를 확인하세요.