Erste Schritte

Schnellstart

API-Schlüssel erstellen, Domain verifizieren und eine kontrollierte E-Mail mit einer wiederholungssicheren Anfrage senden.

Bevor Sie beginnen

Erstellen Sie einen SendHQ-Workspace und lassen Sie das Dashboard geöffnet. Neue Workspaces erhalten eine kontrollierte Integrationstestphase: Zustellungen sind nur an die E-Mail-Adresse des Kontos oder an eine Simulator-Adresse von AWS SES möglich, bis ein kostenpflichtiges Abonnement aktiv ist.

1. API-Schlüssel erstellen

Öffnen Sie im Dashboard API keys, wählen Sie einen aussagekräftigen Namen wie Production und kopieren Sie den Schlüssel, sobald er angezeigt wird. Speichern Sie ihn serverseitig in einem Secret Manager. SendHQ gibt den vollständigen Wert nie wieder aus.

.env
SENDHQ_API_KEY=re_your_key_here

2. Absenderdomain hinzufügen

Öffnen Sie Domains, fügen Sie eine Domain hinzu, die Sie kontrollieren, und veröffentlichen Sie die zurückgegebenen Einträge für DKIM, SPF, DMARC und die SES-Verifizierung. Cloudflare-Nutzer können eine einmalige DNS-Einrichtung autorisieren; SendHQ verwirft das OAuth-Token nach dem Callback.

Veröffentlichen Sie keine zweite SPF-Richtlinie.Wenn bereits ein SPF-Eintrag existiert, ergänzen Sie include:amazonses.com im vorhandenen v=spf1-Wert.

3. Auf die Verifizierung warten

Verwenden Sie das Dashboard oder POST /domains/:id/verify. Der DNS-Status kann pending, checking und propagating durchlaufen, bevor SES die Identität als verified meldet.

4. Kontrollierte Nachricht senden

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

Eine erfolgreiche Anfrage gibt eine SendHQ-E-Mail-ID, die Nachrichten-ID des Providers und die Thread-ID der Konversation zurück. Speichern Sie die SendHQ-ID zusammen mit dem Anwendungsereignis, das die E-Mail ausgelöst hat.

5. Ergebnisse verarbeiten

Eine angenommene API-Anfrage ist nicht dasselbe wie die Zustellung an den Empfänger. Rufen Sie /emails/:id/events ab oder nutzen Sie das Dashboard, um Events zu Zustellung, Bounce, Beschwerde, Ablehnung, Öffnung und Klick einzusehen.