API
Co v této nápovědě naleznete?
Co je API a k čemu slouží
API (zkratka pro Application Programming Interface) je rozhraní, pomocí kterého mohou komunikovat dvě aplikace mezi sebou a vyměňovat si tak data. Jsou různé možnosti, jak nastavit API, lze mít obousměrnou komunikaci, nebo pouze jednosměrnou. Ve SmartEmailingu máme jednosměrnou komunikaci a to směrem dovnitř.
Jedná se tedy o balík metod, které lze použít pro komunikaci mezi SmartEmailingem a jinou aplikací (která API podporuje). Pokud budete chtít komunikovat s aplikací jinak než dle metod popsaných v tomto balíku, budete aplikací odmítnuti.
Za možnost používání API nic nepřiplácíte, API je zcela zdarma.
API dokumentace
Aby mohla komunikace probíhat správně, musíte vědět, jak zadat validní požadavek (request). Přesně k tomu slouží naše API dokumentace. Dále máte volně k dispozici také dokumentaci pro CSV statistické API.
Jak vygenerovat API klíč
Budete také potřebovat autorizaci pomocí API klíče a platného uživatelského jména. API klíč lze vygenerovat v části Nastavení → Datové zdroje → API klíče → + Vytvořit API klíč. V této části také naleznete dostupná uživatelská jména (username), potřebná pro komunikaci.
Pozor, API klíč se vám ukáže pouze jednou, jakmile záložku zavřete, z bezpečnostních důvodů již nepůjde zpětně zobrazit!
API hlásí chybu
Pokud nefunguje API volání, je chyba s největší pravděpodobností v zadání požadavku, který odesíláte. V principu vždy z vaší strany zadáváte požadavek (tzv. request) a ten, pokud není zcela validní, při odeslání vyvolá chybu.
Zda je naše API funkční si ověříte jednoduše, zadáním odkazu https://app.smartemailing.cz/api/v3/ping do okna prohlížeče. Odpověď by měla vypadat jako na obrázku níže.
Dříve než budete kontaktovat podporu SmartEmailingu, ujistěte se prosím, že váš požadavek nemá formální chyby (např. chybějící či přebývající závorky), většina platforem, kam své požadavky zadáváte je dokáže před odesláním překontrolovat a na případné chyby upozornit. Pokud již požadavek odešlete a přichází zpět chybová hláška, přečtěte si ji prosím. V chybové hlášce je většinou jasně uvedeno, proč nelze požadavek zpracovat.
Pokud ani z jednoho nedokážete chybu vyčíst, je potřeba nám zaslat ukázku kódu (zmíněný request, požadavek), který onu chybu vyvolává, spolu s chybovou hláškou, která se vám následně vrátí.