Přejít na dokumentaci
API

Rychlý start

Klíč a první odeslání.

1. Vytvořte klíč

  1. Otevřete Nastavení → API klíče. Ta stránka tam je jen tehdy, když schránku vlastníte.
  2. Pojmenujte ho podle toho, co ho bude používat. Podle toho názvu ho pak najdete, až bude potřeba něco odvolat.
  3. Zvolte jeho scopy. Ve výchozím stavu jen odesílání.
  4. Volitelně zužte, za co smí odesílat: celé domény, jednotlivé adresy, nebo obojí. Celá doména pokrývá i adresy, které na ní vzniknou později.
  5. Zkopírujte klíč. Zobrazí se jednou a nelze ho obnovit: ukládá se jednosměrný hash. Pozdější rotace klíče ukáže náhradu jednou úplně stejně.

2. Něco odešlete

npm install @openemail/sdk

Nepovinné. Každý endpoint je prosté HTTP a JSON a záložka curl níž nepotřebuje nainstalovat vůbec nic.

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

200 znamená, že zpráva odešla. Zpátky dostanete id. Uschovejte ho: tím si zprávu načtete, přečtete její stopu událostí nebo ji zrušíte, pokud jste ji naplánovali.

Dostáváte 403, které jste nečekali? GET /addresses vypíše přesně to, za co tenhle klíč smí odesílat. Skoro vždy jde o scope pro odesílání na klíči nebo o doménu či adresu, kterou nedostal, a ne o chybějící doménu na workspace.