REST API
Ihr Postfach, über schlichtes HTTP.
Senden, lesen und verwalten Sie Mail aus Ihrem eigenen Code. Jeder Schlüssel hat nur die Geltungsbereiche, die Sie ihm geben.
Kurz gesagt
Was ist eine E-Mail-API?
Mit einer E-Mail-API sendet und liest Software Mail über HTTP statt über eine App. Ein Schlüssel an jeder Anfrage entscheidet, worauf der Aufrufer zugreifen darf.
104
dokumentierte Operationen
25
ganze Domains, als die ein Schlüssel senden darf
50
einzelne Adressen zusätzlich
So funktioniert es
Ein Schlüssel, eine Aufgabe
Wählen Sie die Geltungsbereiche eines Schlüssels und optional seine Absender. Fehlt ein Geltungsbereich oder ist der Absender nicht gelistet, gibt es einen 403.
Wiederholen, ohne doppelt zu senden
Jeder Versand erhält seine msg_ id, bevor etwas hinausgeht. Ein erneuter Versuch mit demselben Idempotency-Key gibt das erste Ergebnis zurück.
Secret rotieren, Schlüssel behalten
Rotieren tauscht nur das Secret aus, id, Geltungsbereiche und Anfrageverlauf bleiben also bestehen. Ein widerrufener Schlüssel erhält revoked_api_key.
Mögliche Geltungsbereiche
Dreißig insgesamt. Neue Schlüssel beginnen mit emails:send.
Ihre erste E-Mail senden
Schlichtes HTTP und JSON. Nichts zu installieren.
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'Was Sie bekommen
Heute schon im Produkt
Jeder Versand hat eine id
/events je Empfänger, /tracking für Öffnungen und Klicks.
Ein 403, erklärt
GET /ping zeigt die Geltungsbereiche des Schlüssels und was seine Rolle übrig ließ.
Schlüssel über MCP
Auch der MCP-Server listet, rotiert, widerruft und aktiviert Schlüssel.
Praxistipps
Das Beste daraus machen
- 01
Ein Schlüssel pro Dienst
Der Widerruf eines geleakten Schlüssels stoppt dann nur eine Integration, nicht alle.
- 02
Einen Idempotency-Key setzen
Aus etwas Eindeutigem ableiten, etwa einer Rechnungsnummer, damit ein erneuter Versuch das erste Ergebnis wiederholt.
- 03
Den Absender eingrenzen
Listen Sie nur die Adressen auf, von denen ein Dienst sendet. Eine ganze Domain deckt auch später hinzugefügte ab.
Stand der Dinge
Gut zu wissen
- Kein Upload-Endpunkt
- Eingebettete Anhänge gehen als base64, insgesamt bis 5 MB. Größere Dateien laufen über die id einer Workspace-Datei, als Download-Link.
- Kein Status „Unzustellbar“
- GET /emails führt eine unzustellbare Nachricht als gesendet. Die Unzustellbarkeit zeigt sich beim Empfänger und in einem email.bounced-Webhook.
Fragen
Häufig gefragt
Weiterlesen
Passt gut zu
Loslegen
Ihre Domain,
Ihre Mail.
Richten Sie eine Domain auf OpenEmail aus und lesen Sie sie in einem Postfach, das dafür gebaut ist. Der kostenlose Tarif umfasst eine Domain.
