API a webhooky

Co se stane

Apex popíše kroky: Váš systém předá každého zákazníka, který se registruje nebo předplatí, jako chráněného zákazníka pod Vaším vlastním ID; stávající zákazníky předá v dávkách, nejvýše 10 000 jedním voláním; a zákazníka, který zruší, smaže, takže ho lze znovu oslovit. U firemní adresy je správnou volbou doména, u bezplatné pošty (například gmail.com) samotná e-mailová adresa.

Kde to uvidíte

V chatu, v odpovědi Apexu. Klíč vytvoříte v nabídce účtu, v položce API a webhooky, v zobrazení Klíče.

Chráněnému zákazníkovi nepíše žádná kampaň, ani ta určená stávajícím zákazníkům. Ty, kterým psát chcete, například v kampani na opakovaný nákup, nahrajete do kampaně a neoznačíte je jako chráněné.

Co se stane

Apex projde kroky: systém tiskárny si vyžádá export adres kampaně, jen nových nebo všech, velký export čte po stránkách a po odeslání poštou zpětně hlásí datum podání u každé firmy. Do stavu „Podáno“ se může dostat jen firma ve stavu „Exportováno“.

Kde to uvidíte

V chatu, v odpovědi Apexu.

Je to stejný export jako v rozhraní a objeví se i v části Moje exporty. Testovací klíč vrací ukázkové adresy ve všech balíčcích.

Co se stane

Apex vysvětlí, že v zobrazení Webhooky je třeba přidat nový koncový bod s adresou CRM a zaškrtnout událost Pozitivní odezva. Podpisové tajemství vývojář dostane jen jednou a uloží si ho. Pokud bylo CRM chvíli nedostupné, dotažení firem s pozitivní odezvou doplní, co mezitím chybělo.

Kde to uvidíte

V chatu, v odpovědi Apexu. Koncový bod přidáte v nabídce účtu, v položce API a webhooky, v zobrazení Webhooky.

Tento webhook předává i kontakt, proto je každé jeho doručení exportem a objeví se i v části Moje exporty.

Co se stane

Apex popíše čtyři kroky: vývojář přečte nezpracované tělo, vypočte podpis HMAC-SHA256 z časové značky a těla pomocí tajemství koncového bodu, porovná ho s hodnotou v1 v hlavičce Trendizz-Signature porovnáním v konstantním čase a odmítne požadavek starší než 5 minut. Ukázky kódu jsou v dokumentaci.

Kde to uvidíte

V chatu, v odpovědi Apexu.

Co se stane

Apex vysvětlí, že k tomu je potřeba klíč pro přehledy se jménem agentury. Tento klíč čte jen účet a přehled kampaní, souhrnně a po dnech, týdnech nebo měsících, nic nemůže zapisovat a lze ho zrušit jednotlivě. Agentura ho používá Vaším jménem ve svém systému nebo tabulce.

Kde to uvidíte

V chatu, v odpovědi Apexu. Klíč vytvoříte v nabídce účtu, v položce API a webhooky, v zobrazení Klíče.

Přehled dává jen počty, žádné firmy ani kontakty. Čísla jsou stejná jako na stránkách kampaní v Trendizzu.

Co se stane

Apex přečte protokol volání a řekne, co se stalo, kdy, s kterým klíčem a jménem koho: úspěšná volání a u chyb význam chybového kódu. Na požádání otevře zobrazení Protokol volání.

Kde to uvidíte

V chatu, v odpovědi Apexu, a vpravo v zobrazení Protokol volání v části API a webhooky.

Úplnou odpověď volání, které vyvezlo data, může otevřít jen autor klíče; Superuživatel a administrátoři, pokud klíč nevytvořili, vidí souhrn: kolik firem a jaká pole odešla.

Co se stane

Apex přečte koncové body webhooků a doručení: co odešlo, kdy, co koncový bod odpověděl a pokud je koncový bod chybný nebo pozastavený, proč. Otevře zobrazení Webhooky, na požádání jeden koncový bod.

Kde to uvidíte

V chatu, v odpovědi Apexu, a vpravo v zobrazení Webhooky.

Znovu odeslat a znovu spustit lze tlačítky v zobrazení Webhooky; může to udělat Superuživatel účtu nebo Administrátor.