Pomocí API snadno propojíte vlastní řešení s naší aplikací. Docílíte komplexnějších scénářů, nastavíte vlastní formuláře, transakční e-maily nebo jiné cíle.
Nemáte ještě svůj Ecomail?
POZOR ⚠️ Requesty je potřeba odesílat jako JSON payload s hlavičkou:
Content-Type: application/json
Více o JSON se dozvíte zde. Konkrétní příklady naleznete v naší API dokumentaci.
V tomto článku naleznete:
👉 API dokumentace 👈
Jaké možnosti API nabízí
Seznamy kontaktů
Parametr trigger_autoresponders umožňuje spuštění automatizací s triggerem Přihlásí se do seznamu
Je vždy třeba zasílat veškeré štítky, které má kontakt mít
Pomocí parametru update_existing je možné existující kontakt aktualizovat
Kontakty
Smaže kontakt s veškerými daty z databáze
Kampaně
Automatizace
Na základě ID automatizace a e-mailové adresy kontaktu
Šablony
Pouze pro šablony tvořené vlastním HTML.
Domény
Transakční e-maily
Transakce (objednávky)
Pro co nejsnazší práci s transakcemi v aplikaci pracujte s názvem obchodu
Aktualizace konkrétní transakce - na základě jejího ID
Odstranění konkrétní transakce - na základě jejího ID
Produktové feedy
Datové feedy
Vlastní události
Více k zasílání vlastních událostí naleznete zde.
Vyhledání kontaktu
Slevové kupony
Webhooky
Slouží k definování adresy, na kterou bude Ecomail odesílat statistiky kampaní
Vrátí aktuálně konfigurovanou URL adresu pro zasílání statistik kampaní.
Odstraní aktuálně konfigurovanou URL adresu pro zasílání statistik kampaní.
Jak propojení skrze API nastavit
Pro využití API budete potřebovat API klíč, který naleznete ve správě vašeho účtu v sekci Pro vývojáře.
API klíč je viditelný pouze pro uživatele s rolí administrátora.
Dokumentaci k API naleznete na webové adrese: https://docs.ecomail.cz/
Může se stát, že budete potřebovat vygenerovat nový API klíč. Nový api klíč vygenerujte kliknutím na tlačítko "Obnovit API klíč" vedle api klíče.
⚠️ Po změně již nebude možné pracovat s původním API klíčem. Nezapomeňte tak změnit hodnotu API klíče ve Vašich integracích s Ecomailem, abyste je mohli dále využívat.
Veškeré informace o tom, jaká data je možné do Ecomailu přenášet najdete přehledně popsané v tomto článku.
Časté dotazy
Jak poznám, že je API správně napojené?
Vyzkoušejte si provést testovací objednávku, nebo registraci kontaktu. Změny uvidíte v seznamu kontaktů.
Má API nějaké omezení?
API má omezení 1 000 callů za minutu. Pokud dojde k přesažení limitu, requesty budou vrácený se status kódem 429 a hlavičkou Retry-After.
V jakém tarifu mohu využívat API?
API je možné využít v jakémkoliv tarifu.
Pokročilejší funkce, jako jsou transakce, transakční e-maily, či pokročilá segmentace jsou však dostupné pouze v tarifech Marketer+ a CDP.
Kde najdu ID seznamu kontaktů?
V některých API requestech je potřeba uvést také ID seznamu kontaktů ve formě čísla (např. u requestu pro přidání nového kontaktu).
ID seznamu najdete v URL řádku prohlížeče v okamžiku, kdy máte příslušný seznam v aplikaci otevřen:
Všechny seznamy a jejich ID naleznete také přes tento API endpoint.
💭 Nenašli jste odpověď?
Napište nám na chat, anebo na e-mail support@ecomail.cz. 😊