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

API pro e-mailing a webhooky

Veřejné API s dokumentací, klíči s oprávněními a testovacím režimem. Součást placených tarifů.

  • Dokumentace dostupná bez přihlášení
  • Testovací klíč nic neodešle
  • Součást placených tarifů

Začnete zdarma a bez platební karty.

Napojení na váš systém

Veřejné API NG Emailingu propojí váš systém s kontakty, kampaněmi, šablonami a transakčními e-maily. Kampaň přes něj připravíte i odešlete. V jednom požadavku nahrajete až 1 000 kontaktů a přístup omezíte na vyjmenované IP adresy.

API a integrace podrobněji

Co přes API uděláte

API pracuje s kontakty, skupinami, odběry, segmenty, šablonami, kampaněmi, automatizacemi, transakčními zprávami a výsledky. Kampaň přes něj připravíte i odešlete. Pravidla aplikace platí i tady: import ani skupina nevytvářejí marketingový souhlas.

  • Hromadné nahrání až 1 000 kontaktů v jednom požadavku
  • Transakční zpráva nebo dávka až 50 příjemců
  • Čtení výsledků má vlastní limit a nezpomalí odesílání

Klíče s oprávněními a povolené IP adresy

Každý přístup má název, režim, platnost a oprávnění po oblastech. Celý klíč aplikace ukáže jen jednou, při vytvoření. Přístup omezíte na vyjmenované IP adresy, nejvýš 20 položek.

  • Náhradní klíče a historie přístupu
  • Pozastavení a zneplatnění přístupu jedním krokem
  • Sdílení přístupu mezi projekty jedné organizace
  • Upozornění na podezřelou aktivitu klíče

Testovací režim a dokumentace

Testovací klíč požadavky ověří a nasimuluje. Nezmění ostré kontakty a neodešle e-mail ani webhook. Dokumentace API je veřejná, má vyhledávání, katalog chybových kódů a kontrakt OpenAPI ke stažení.

  • První transakční e-mail ve 4 krocích
  • Příklady v cURL, PHP a Node
  • Postup „Napojení CRM krok za krokem“ v dokumentaci

Podepsané webhooky

Webhook je adresa ve vašem systému, na kterou aplikace posílá podepsané zprávy o stavu transakčních e-mailů. Podpisové tajemství ukáže jen jednou a jde otočit. U každého webhooku vidíte historii doručení a úspěšnost.

  • Zkušební událost pro ověření napojení
  • Dočasné vypnutí a zapnutí webhooku
  • Události jde číst také dotazem přes API

Co umí API a integrace v NG Emailingu

Veřejné APIKontakty, skupiny, odběry, segmenty, šablony, kampaně, automatizace a transakční zprávy.
API klíčeTestovací a ostrý režim, oprávnění po oblastech, platnost a náhradní klíče.
Testovací režimTestovací klíč požadavky jen simuluje a nic neodešle.
Povolené IP adresyOmezení přístupu na vyjmenované adresy, nejvýš 20 položek.
DokumentaceVeřejná dokumentace s hledáním a katalogem chybových kódů.
OpenAPIStrojově čitelný kontrakt API ke stažení.
Záložka ZačínámePrvní transakční e-mail ve 4 krocích s příkladem v cURL, PHP a Node.
WebhookyPodepsané události, historie doručení a zkušební událost.
Bezpečné opakováníKlíč Idempotency-Key chrání před dvojím zápisem i dvojím odesláním.
Sdílení mezi projektyJeden přístup pro více projektů, s oprávněními pro každý zvlášť.

Co zatím neumí

  • API a webhooky jsou jen v placených tarifech. Tarif Free je neobsahuje.
  • Hotové napojení na e-shopy a CRM systémy v nabídce není. Propojení postavíte přes API.
  • Hotové knihovny (SDK) pro jednotlivé jazyky nejsou. K dispozici je dokumentace, OpenAPI a příklady.

Časté dotazy

Nenašli jste odpověď? Napište na podpora@ngemailing.cz nebo se podívejte do všech dotazů.

Je API dostupné v tarifu Free?

Ne. API a webhooky jsou součástí placených tarifů, které začínají od 100 Kč měsíčně bez DPH. Tarif Free API neobsahuje.

Můžu API vyzkoušet, aniž bych něco odeslal?

Ano. Vytvoříte přístup v testovacím režimu. Testovací klíč požadavky ověří a nasimuluje, ale neodešle žádný e-mail ani webhook.

Jak API klíč zabezpečím?

Klíči dáte jen oprávnění, která potřebuje, a nastavíte mu platnost. Přístup omezíte na povolené IP adresy. Klíč můžete kdykoli pozastavit, vyměnit za náhradní nebo zneplatnit.

Dá se NG Emailing propojit s e-shopem nebo CRM?

Hotové napojení na konkrétní e-shopy a CRM systémy v nabídce není. Propojení postaví váš vývojář přes veřejné API a webhooky. Kontakty také nahrajete importem ze souboru.

K čemu jsou webhooky?

Webhook pošle vašemu systému zprávu, když se změní stav transakčního e-mailu, například při doručení nebo vrácení. Zprávy jsou podepsané, takže si ověříte, že přišly z NG Emailingu.

Co když se požadavek na API kvůli výpadku zopakuje?

Každý zápis posíláte s vlastním klíčem Idempotency-Key. Opakování se stejným klíčem se provede jen jednou, takže e-mail neodejde dvakrát.

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