Erster Versand per API
Sie brauchen
Abschnitt betitelt „Sie brauchen“- Ein Projekt mit verbundener Domain und Versandberechtigung für Ihre Absenderadresse.
- Einen API-Schlüssel für diesen Absender. Er wird beim Erstellen einmal angezeigt; speichern Sie ihn sofort in Ihrem Secret-Manager. Das Erstellen verlangt Ihren zweiten Faktor.
- Die Stream-ID, die beim Zugang angezeigt wird. View API examples beim Zugang füllt die Anfrage unten für Sie aus.
Schnellster Weg
Abschnitt betitelt „Schnellster Weg“- Öffnen Sie in Control Ihr Projekt und API keys & SMTP.
- Wählen Sie beim API-Schlüssel View API examples. Geben Sie Ihre Empfängeradresse ein; Betreff und Text sind vorausgefüllt.
- Setzen Sie Ihren gespeicherten Schlüssel als
WENEED_API_KEYim Terminal und kopieren Sie den erzeugten cURL-Befehl. Absender, Stream und Nachrichten-ID sind bereits eingetragen; Antwort und HTTP-Status werden automatisch angezeigt. - Öffnen Sie Messages, um den Zustellstatus zu sehen.
Behalten Sie für einen erneuten Versuch denselben Befehl. Ein neu erzeugtes Beispiel steht für eine neue Nachricht. Die Node.js-Alternative ist auf derselben Seite verfügbar.
API-Anfrage im Detail
Abschnitt betitelt „API-Anfrage im Detail“curl -sS "https://api.weneed.email/v1/emails" \ -H "Authorization: Bearer $WENEED_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: signup-7f3c2a91-welcome" \ -d '{ "stream_id": "IHRE-STREAM-ID", "from": { "email": "hallo@ihredomain.at", "name": "Ihre App" }, "to": [ { "email": "person@example.com" } ], "subject": "Willkommen", "text": "Danke für Ihre Anmeldung." }'Die Antwort ist 202 mit einer Nachrichten-ID. Die Nachricht ist damit gespeichert und
eingereiht. Den Zustellstatus sehen Sie im Nachrichtenverlauf.
Der Idempotency-Key ist wichtig
Abschnitt betitelt „Der Idempotency-Key ist wichtig“Idempotency-Key ist Pflicht: 16 bis 128 druckbare Zeichen, die genau diese eine Absicht
benennen, etwa die ID des Anmeldeereignisses. Bricht die Anfrage ab, senden Sie sie erneut mit
demselben Key und demselben Inhalt. Sie erhalten die ursprüngliche Nachricht statt eines Duplikats.
Erzeugen Sie für einen Wiederholungsversuch nie einen neuen Key. Siehe Wiederholungen und Duplikate.
Optionale Felder
Abschnitt betitelt „Optionale Felder“| Feld | Zweck |
|---|---|
html |
HTML-Inhalt. Senden Sie text, html oder beides. |
reply_to |
Eine Antwortadresse. Eine Domain-Verifizierung legt kein Postfach an; nutzen Sie ein bestehendes. |
expires_at |
Nach diesem Zeitpunkt nicht mehr senden. Sinnvoll für Einmalcodes. |
tags |
Bis zu 10 Schlüssel-Wert-Paare für Ihre eigene Filterung. |
Alle Endpunkte und Antwortcodes stehen in der API-Referenz.