API

Schnellstart

Ein Schlüssel und ein erster Versand.

1. Einen Schlüssel erstellen

Öffnen Sie Einstellungen → API-Schlüssel. Die Seite ist nur da, wenn Ihnen das Postfach gehört.
Benennen Sie ihn nach dem, was ihn nutzen wird. Über diesen Namen finden Sie ihn wieder, wenn etwas widerrufen werden muss.
Wählen Sie seine Scopes. Standardmäßig nur Senden.
Optional einschränken, als was er senden darf: ganze Domains, einzelne Adressen oder beides. Eine ganze Domain umfasst auch Adressen, die ihr später hinzugefügt werden.
Kopieren Sie den Schlüssel. Er wird einmal angezeigt und ist nicht wiederherstellbar: Gespeichert wird ein Einweg-Hash. Ein späteres Rotieren des Schlüssels zeigt den Ersatz auf dieselbe Weise ein einziges Mal.

2. Etwas senden

npm install @openemail/sdk

Optional. Jeder Endpunkt ist schlichtes HTTP und JSON, und der curl-Tab unten benötigt überhaupt keine Installation.

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

Ein 200 heißt, sie ist raus. Sie erhalten eine id zurück. Behalten Sie sie: Damit rufen Sie die Nachricht ab, lesen ihren Ereignisverlauf oder stornieren sie, wenn Sie sie geplant haben.

Ein unerwartetes 403? GET /addresses listet genau auf, als was dieser Schlüssel senden darf. Fast immer liegt es am Sende-Scope des Schlüssels oder an einer Domain bzw. Adresse, die ihm nicht gegeben wurde, und nicht an einer fehlenden Domain im Workspace.