Novinka Spustili jsme novou aplikaci NG Emailing. Proč vznikla a co je v ní jinakNová aplikace: proč vznikla

Transakční e-mail přes API: první zpráva

Stručně

První transakční e-mail odešlete tak, že publikujete transakční šablonu, vytvoříte API klíč a zavoláte API s ID šablony a příjemcem. Funguje to jen v placeném tarifu, tarif Free API ani transakční e-maily nemá.

Transakční e-mail je zpráva, kterou váš e-shop nebo aplikace pošle jednomu příjemci, například potvrzení objednávky. Potřebujete ověřenou vlastní doménu, bez ní se neodesílá. Ceny a tarify najdete na stránce Ceník. Zprávy nelze posílat s přílohami ani přes SMTP. Počítají se do stejného limitu e-mailů jako kampaně.

Co si připravit

  1. Placený tarif. Bez něj stránka API a integrace ukáže hlášku API a integrace jsou dostupné jen v placeném tarifu a volání API server odmítne chybou api_plan_required. Tarif si objednáte v části Tarif a fakturace.
  2. Ověřená doména a odesílatel. Viz Ověření domény.
  3. Transakční šablona. V Šablonách vytvořte šablonu s účelem Transakční, popište vlastní vstupní pole a publikujte konkrétní verzi. Účel se po vytvoření nemění. Podrobnosti viz Transakční šablony: vstupní pole a publikace.

První zpráva ve čtyřech krocích

Postup najdete také v aplikaci v API a integrace na záložce Začínáme.

Záložka Začínáme v API a integrace: čtyři kroky a ukázka požadavku.
Záložka Začínáme v API a integrace: čtyři kroky a ukázka požadavku.
  1. Vytvořte přístup. V API a integrace otevřete záložku API přístupy a přidejte integraci. Začněte přístupem v režimu Testovací. Volání jen nasimuluje a nic neodešle. Podrobnosti o klíčích viz API klíče: režimy, oprávnění a povolené IP adresy.
  2. Zkopírujte ID šablony. V knihovně šablon najdete ID u každé transakční šablony. Šablona musí být publikovaná.
  3. Pošlete první požadavek. Na záložce Začínáme zvolte nad kódem cURL, PHP nebo Node. Příklad už obsahuje adresu API, ID vašeho projektu a ID první publikované transakční šablony. Pokud projekt žádnou publikovanou šablonu nemá nebo ji vaše role nevidí, je v příkladu ID_ŠABLONY. Klíč vložte místo VÁŠ_KLÍČ. PHP a Node ho čtou z proměnné NG_API_KEY. Tlačítko s ikonou kopírování zkopíruje celý příklad. Odpověď 202 znamená, že jsme e-mail přijali. Neznamená, že byl doručen.
  4. Přepněte na ostrý klíč. Až test projde, vytvořte ostrý přístup a klíč ve své aplikaci vyměňte.

Úplný popis požadavků, chyb a limitů je ve veřejné dokumentaci API. Odkaz na ni je také na záložce Začínáme (Dokumentace API).

Jedním požadavkem můžete poslat i dávku, nejvýše 50 příjemců.

Ruční test bez kódu

Než napojíte e-shop, můžete zprávu vyzkoušet v aplikaci. V Transakční e-maily zvolte Otestovat zprávu. Vyplníte šablonu, odesílatele, adresu příjemce, referenci a vstupní pole. Pak zobrazíte náhled (Zkontrolovat a zobrazit náhled), zaškrtnete potvrzení a zvolíte Odeslat jednu testovací zprávu. E-mail skutečně odejde. Test vyžaduje publikovanou šablonu a povoleného odesílatele.

Kde zprávu uvidíte

Stránka Transakční e-maily má záložky Přehled, Zprávy a API požadavky. V Zprávách vidíte čas, příjemce a stav. Stav může být Ve frontě, Odesílá se, Předáno, Doručeno, Nedoručeno, Zdržuje se, Vyžaduje pozornost nebo Zrušeno. Stav Předáno neznamená Doručeno. Detail zprávy ukazuje průběh a u problému jeho důvod.

Seznam transakčních zpráv s časem, příjemcem, stavem doručení a šablonou.
Seznam transakčních zpráv s časem, příjemcem, stavem doručení a šablonou.

Více viz Transakční zprávy: stav a proč zpráva nedorazila.

Záložka Přehled ukazuje stav fronty, rychlost předání a čísla dne: dnes přijato, doručeno a zprávy vyžadující pozornost.

Přehled Transakční e-maily: rychlost předání, počet zpráv za dnešek a podíl doručených.
Přehled Transakční e-maily: rychlost předání, počet zpráv za dnešek a podíl doručených.

Když to nejde

  • API odmítne požadavek. Zkontrolujte tarif (Free API nemá), klíč a režim klíče. Vývojáři předejte HTTP stav, code, request_id a případná fields. API klíč nikdy nesdílejte. Odmítnutá volání uvidíte v záložce API požadavky.
  • V příkladu zůstalo ID_ŠABLONY. Šablona není publikovaná, nebo ji vaše role nevidí. Publikujte ji a zkopírujte její ID.
  • Šablonu nejde publikovat. Šablonu s odkazem na doménu NG Emailingu nepublikujete. Příjemce smí vidět jen adresy na vaší doméně. Odkaz nahraďte a publikujte znovu.
  • Zpráva nedorazila. Otevřete její detail v záložce Zprávy. Část Proč se nedoručilo vysvětlí důvod a ukáže, co se s adresou stalo. Stav Zdržuje se znamená, že server příjemce zprávu zatím nepřijal a doručování se zkouší dál.

Časté dotazy

Čím se transakční e-mail liší od kampaně?

Kampaň jde skupině příjemců a posíláte ji z aplikace. Transakční zprávu pošle váš systém jednomu příjemci podle šablony. Marketingové kampaně a automatizace transakční šablonu nepřijmou.

Mohu posílat přílohy nebo používat SMTP?

Ne. Zprávy se odesílají jen přes API a bez příloh. Plánované funkce najdete na stránce Co chystáme.

Mám hotové napojení na svůj e-shop?

Hotová napojení na konkrétní e-shopy aplikace nenabízí. Zprávu posílá váš e-shop nebo vlastní aplikace přes API. Plánované funkce najdete na stránce Co chystáme.

Co když požadavek omylem zopakuji?

API umí bezpečné opakování. Pokud při volání uvedete klíč idempotence (hlavička Idempotency-Key), opakovaný požadavek nepošle druhý e-mail. Podrobnosti jsou v dokumentaci API.

Další krok

Pokračujte návodem Transakční šablony: vstupní pole a publikace. Přehled možností najdete na stránce Transakční e-maily.

Nevíte si rady? V aplikaci se zeptejte AI pomocníka nebo napište podpoře. Jak podpora funguje

První kampaň můžete odeslat ještě dnes

Začnete zdarma a bez platební karty. Stačí ověřit doménu, nahrát kontakty a vybrat šablonu.

Free: 100 kontaktů a 200 e-mailů měsíčně.

Používáme nezbytné cookies. Se souhlasem také měříme návštěvnost a reklamu (Google Analytics, Google Ads). Podrobnosti