Ugrás a dokumentációra
API

Gyors kezdés

Egy kulcs és egy első küldés.

1. Kulcs létrehozása

  1. Nyisd meg a Beállítások → API kulcsok oldalt. Az oldal csak akkor érhető el, ha a postafiók a tiéd.
  2. Nevezd el arról, ami használni fogja. Erről a névről találod meg újra, amikor valamit vissza kell vonni.
  3. Válaszd ki a hatóköreit. Alapértelmezés szerint csak küldés.
  4. Opcionálisan szűkítheted, milyen néven küldhet: teljes domainek, egyedi címek, vagy mindkettő. Egy teljes domain a később hozzáadott címeket is lefedi.
  5. Másold ki a kulcsot. Csak egyszer jelenik meg, és nem állítható vissza: egyirányú hash kerül tárolásra. A kulcs későbbi rotálásakor a csere ugyanígy egyszer jelenik meg.

2. Küldj valamit

npm install @openemail/sdk

Opcionális. Minden végpont sima HTTP és JSON, és az alábbi curl fülhöz semmit nem kell telepíteni.

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

A 200 azt jelenti, hogy elment. Visszakapsz egy id-t. Őrizd meg: ezzel kérheted le az üzenetet, olvashatod az eseménynaplóját, vagy vonhatod vissza, ha ütemezted.

Váratlan 403-at kapsz? A GET /addresses pontosan felsorolja, milyen néven küldhet ez a kulcs. Szinte mindig a kulcs küldési hatóköre, vagy egy domain vagy cím, amelyet nem kapott meg, és nem a munkaterületről hiányzó domain.