Przejdź do dokumentacji
API

Szybki start

Klucz i pierwsza wysyłka.

1. Utwórz klucz

  1. Otwórz Ustawienia → Klucze API. Strona jest tam tylko wtedy, gdy jesteś właścicielem skrzynki.
  2. Nazwij go od tego, co będzie go używać. Po tej nazwie znajdziesz go ponownie, gdy trzeba będzie coś odwołać.
  3. Wybierz jego zakresy. Domyślnie tylko wysyłka.
  4. Opcjonalnie zawęź to, jako co może wysyłać: całe domeny, pojedyncze adresy albo jedno i drugie. Cała domena obejmuje adresy dodane do niej później.
  5. Skopiuj klucz. Jest pokazywany raz i nie da się go odzyskać: przechowywany jest skrót jednokierunkowy. Późniejsza rotacja klucza w ten sam sposób raz pokazuje jego następcę.

2. Wyślij coś

npm install @openemail/sdk

Opcjonalne. Każdy endpoint to zwykły HTTP i JSON, a zakładka z curl poniżej nie wymaga instalowania czegokolwiek.

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 oznacza, że wiadomość poszła. Dostajesz z powrotem id. Zachowaj je: to dzięki niemu pobierzesz wiadomość, odczytasz jej ślad zdarzeń albo anulujesz ją, jeśli została zaplanowana.

Dostajesz 403, którego się nie spodziewałeś? GET /addresses wypisuje dokładnie to, jako co ten klucz może wysyłać. Prawie zawsze chodzi o zakres wysyłki na kluczu albo o domenę czy adres, których mu nie przyznano, a nie o brakującą domenę w przestrzeni roboczej.