Přehled
Přehled pro vývojáře
Základní URL, autentizace, ID objektů, chyby, stránkování, limity rychlosti, SDK, webhooky a MCP. Konvence, které sdílí každá integrace s Emailitem.
Tato stránka shrnuje konvence, které potřebujete znát, než začnete psát kód pro Emailit: kde API najdete, jak se požadavky autentizují, jak se identifikují objekty a jak fungují chyby, stránkování a limity rychlosti. Každá sekce odkazuje na podrobnou referenci.
Způsoby integrace
| Rozhraní | Endpoint | K čemu slouží |
|---|---|---|
| REST API | https://api.emailit.com/v2 |
Odesílání e-mailů a správa všech zdrojů z kódu. |
| SMTP relay | smtp.emailit.com |
Aplikace, frameworky a CMS, které už umí SMTP. Viz Nastavení SMTP. |
| Webhooky | Váš HTTPS endpoint | Události doručení, zapojení a zdrojů v reálném čase. |
| MCP server | https://api.emailit.com/mcp |
Práce AI asistentů, jako jsou Claude, ChatGPT a Cursor, s vaším workspace. |
| OAuth 2.1 | https://api.emailit.com/oauth/* |
Integrace, které jednají jménem uživatelů Emailitu, aniž by pracovaly s jejich API klíči. |
Nevíte, jestli použít API, nebo SMTP? Přečtěte si stránku Volba mezi API a SMTP.
Základní URL a verzování
Všechny endpointy REST API mají jednu společnou základní URL:
https://api.emailit.com/v2v2 je aktuální a jediná zdokumentovaná verze. Původní API v1 je zastaralé; viz Verzování.
Autentizace
API klíč posílejte jako bearer token v hlavičce Authorization každého požadavku:
curl https://api.emailit.com/v2/domains \
-H "Authorization: Bearer $EMAILIT_API_KEY"- API klíče začínají na
secret_. Starší klíče bez předpony fungují dál. - Každý klíč patří do jednoho workspace a má rozsah oprávnění: Full Access (
full) může volat všechny endpointy, Sending Only (sending) může jen odesílat a spravovat odeslané e-maily. Viz API klíče. - Ve stejné hlavičce se přijímají i přístupové tokeny OAuth vydané OAuth aplikacím.
- Chybějící klíč vrací
401sAPI key required, neznámý klíč vrací401sInvalid API keya zablokovaný workspace vrací403sWorkspace is suspended.
Nikdy nevolejte API se svým klíčem z prohlížeče ani z mobilní aplikace. Klíč uchovávejte na serveru. Podrobnosti: Autentizace.
ID a předpony
Každý objekt má textové ID s předponou typu, takže na první pohled poznáte, k čemu ID patří.
| Objekt | Předpona | Příklad |
|---|---|---|
em_ |
em_4K6oASS7KP9ztzWmSN9ndEu13HW |
|
| Odesílací doména | dom_ |
dom_3xQ7mLp2RkT9vB4nHs8YcWd1Ze6 |
| API klíč | key_ |
key_4F2kN8sQwE1rT6yU3iO9pA7sD5f |
| Seznam kontaktů | aud_ |
aud_3zR8tY2uI6oP4aS1dF9gH7jK5lM |
| Odběratel | sub_ |
sub_4K6oASS7KP9ztzWnqS4svxApJzO |
| Kontakt | con_ |
con_4A9sD2fG6hJ1kL8zX3cV7bN5mQw |
| Šablona | tem_ |
tem_3wE8rT1yU5iO9pA2sD6fG4hJ7kL |
| Blokace | sup_ |
sup_4K6oASS7KP9ztzWol5ElicOeKFE |
| Webhook | wh_ |
wh_3mN7bV2cX6zL9kJ4hG1fD8sA5pO |
| Požadavek webhooku | whr_ |
whr_4K6oASS7KP9ztzWpVUIec9Jneax |
| Událost | evt_ |
evt_4K6oASS7KP9ztzWpqId2iIptac5 |
| Kampaň | cmp_ |
cmp_4B1nM5qW9eR3tY7uI2oP6aS8dF4 |
| Formulář | frm_ |
frm_4C3vB7nM1qW5eR9tY2uI6oP8aS4 |
| Odpověď formuláře | fsub_ |
fsub_4K6oASS7KP9ztzWqvxLV3IsFRs8 |
| Automatizace | aut_ |
aut_4D5fG9hJ3kL7zX1cV6bN2mQ8wE4 |
| Spuštění automatizace | aur_ |
aur_4K6oASS7KP9ztzWrWOjGgqompRo |
| Ověření e-mailu | ev_ |
ev_4E7gH1jK5lZ9xC3vB8nM2qW6eR4 |
| Seznam k ověření | evl_ |
evl_4F9hJ3kL7zX1cV5bN9mQ2wE6rT8 |
| DMARC report | dmr_ |
dmr_4K6oASS7KP9ztzWsW7e5qkOYHO6 |
Domény vytvořené před přechodem na ID dom_ mohou mít ještě ID sd_ nebo sed_.
Některé endpointy místo ID přijímají i čitelný identifikátor: název u API klíčů, domén, webhooků, kampaní a seznamů kontaktů a e-mailovou adresu u kontaktů a blokovaných adres. E-maily, šablony a události se dohledávají jen podle ID.
Požadavky a odpovědi
- JSON na vstupu i na výstupu. Těla požadavků posílejte jako JSON s
Content-Type: application/json. Chybný JSON vrací400sInvalid JSON in request body. Tělo požadavku může mít až 50 MB; výsledná zpráva MIME e-mailu může mít až 40 MB. - Chyby. Většina chyb vrací
{"statusCode", "error", "message"}. Chyby validace navíc obsahují poledetailsa chyby při odesílání vracejívalidation_errors. Funkce vázané na tarif vracejí403s"error": "plan_required". Viz Chyby. - Stránkování. Endpointy pro výpis přijímají
pagealimit(od 1 do 100) a vracejídata,next_page_urlaprevious_page_url. Šablony a automatizace používajípageaper_page. Viz Stránkování. - Filtrování a řazení. Filtrujte pomocí
field.condition=value, filtry kombinujte smatch=all, nebomatch=ora řaďte pomocíorderadirection. NapříkladGET /v2/emails?status.exact=bounced&order=created_at&direction=desc. Viz Filtrování a řazení. - Idempotence. Posílejte hlavičku
Idempotency-KeyuPOST /emailsaPOST /emails/:id/forward, aby byla opakování požadavků bezpečná. Emailit po dobu 24 hodin vrací znovu první odpověď. Viz Idempotence. - Limity rychlosti. Odesílání je omezené pro každý workspace, ve výchozím stavu na 2 e-maily za sekundu a 5 000 e-mailů za den, společně pro API i SMTP. Odpovědi obsahují hlavičky
ratelimit-*a odpověď429obsahujeretry-after. Viz Limity rychlosti a Limity a kvóty.
SDK
Oficiální knihovny obalují REST API pro Node.js, PHP, Laravel, Python, Ruby, Go, Javu, .NET a Rust. Všechny najdete na GitHubu. Instalační příkazy najdete na stránce SDK a knihovny a kompletní příklady v návodech pro frameworky, počínaje Node.js.
Webhooky
Webhooky posílají události na váš endpoint, jakmile nastanou: doručení, nedoručení, otevření, prokliky, příchozí poštu a změny domén, kontaktů a dalších zdrojů. Každý požadavek obsahuje pole JSON až se 100 událostmi a je podepsaný pomocí HMAC-SHA256 v hlavičce X-Emailit-Signature. Neúspěšné požadavky se opakují, celkem až 11 pokusů. Začněte stránkami Nastavení webhooku a Ověření podpisu webhooků.
MCP server a AI nástroje
Hostovaný MCP server na https://api.emailit.com/mcp dává AI asistentům 109 nástrojů pro celé API v2, od odesílání e-mailů po kampaně a automatizace. Asistenti se přihlašují přes OAuth nebo API klíčem a pluginy Emailit přidávají dovednosti pro ChatGPT, Codex, Claude Code, Cursor a Grok.
Dokumentace je publikovaná i pro AI: každá stránka má verzi v Markdownu a /docs/llms.txt obsahuje rejstřík všech stránek.