API a webhooky

Čo sa stane

Apex povie kroky: Váš systém odovzdá zákazníka, ktorý sa zaregistruje alebo si predplatí, ako chráneného zákazníka pod Vaším vlastným identifikátorom, existujúcich v dávke, najviac 10 000 v jednom volaní, a zákazníka, ktorý zruší, vymaže, takže ho možno znova osloviť. Pri firemnej adrese je správna voľba doména, pri bezplatnej pošte (napríklad gmail.com) samotná e-mailová adresa.

Kde to vidíte

V chate, v odpovedi Apexu. Kľúč vytvoríte v ponuke účtu, v položke API a webhooky, v zobrazení Kľúče.

Chránenému zákazníkovi nepíše žiadna kampaň, ani tá určená existujúcim zákazníkom. Tých, ktorým chcete písať, napríklad v kampani na opakovaný nákup, načítate do kampane a neoznačíte ako chránených.

Čo sa stane

Apex prejde kroky: systém tlačiarne si vyžiada export adries kampane, len nové alebo všetky, veľký export číta po stránkach a po odoslaní poštou po firmách nahlási späť dátum podania. Do stavu „Podané“ sa môže dostať len firma v stave „Vyexportované“.

Kde to vidíte

V chate, v odpovedi Apexu.

Je to ten istý export ako v rozhraní a zobrazí sa aj medzi Mojimi exportmi. Testovací kľúč dáva vzorové adresy v každom balíku.

Čo sa stane

Apex vysvetlí, že v zobrazení Webhooky treba pridať nový endpoint s adresou CRM a zaškrtnúť udalosť Pozitívna odozva. Podpisové tajomstvo vývojár dostane raz a uloží si ho. Ak CRM nejaký čas nebol dostupný, vyžiadanie firiem s pozitívnou odozvou doplní, čo medzitým chýbalo.

Kde to vidíte

V chate, v odpovedi Apexu. Endpoint pridáte v ponuke účtu, v položke API a webhooky, v zobrazení Webhooky.

Tento webhook odovzdáva aj kontakty, preto je každé jeho doručenie exportom a zobrazí sa aj medzi Mojimi exportmi.

Čo sa stane

Apex povie štyri kroky: vývojár načíta surové telo požiadavky, vypočíta podpis HMAC-SHA256 z časovej pečiatky a tela s tajomstvom endpointu, porovná ho s hodnotou v1 hlavičky Trendizz-Signature porovnaním v konštantnom čase a odmietne každú požiadavku staršiu ako 5 minút. Ukážky kódu sú v dokumentácii.

Kde to vidíte

V chate, v odpovedi Apexu.

Čo sa stane

Apex vysvetlí, že na to treba kľúč na reporty s názvom agentúry. Tento kľúč číta len účet a kampaňový report, súhrnne a v dennom, týždennom alebo mesačnom rozpise, nič nemôže zapisovať a dá sa zrušiť jednotlivo. Agentúra ho používa z Vášho poverenia vo svojom systéme alebo tabuľke.

Kde to vidíte

V chate, v odpovedi Apexu. Kľúč vytvoríte v ponuke účtu, v položke API a webhooky, v zobrazení Kľúče.

Report obsahuje len počty, žiadne firmy ani kontakty. Čísla sú rovnaké ako na stránkach kampaní v Trendizzu.

Čo sa stane

Apex prečíta protokol volaní a povie, kedy, s ktorým kľúčom a v mene koho sa čo stalo: úspešné volania a pri chybách význam chybového kódu. Na požiadanie otvorí zobrazenie Protokol volaní.

Kde to vidíte

V chate, v odpovedi Apexu, a vpravo, v zobrazení Protokol volaní v časti API a webhooky.

Úplnú odpoveď volania, ktoré údaje vydalo, môže otvoriť len tvorca kľúča; Superpoužívateľ a Administrátori, ak kľúč nevytvorili oni, vidia súhrn: koľko firiem a ktoré polia odišli.

Čo sa stane

Apex prečíta endpointy webhookov a doručenia: čo odišlo, kedy, čo endpoint odpovedal a ak endpoint zlyháva alebo je pozastavený, prečo. Otvorí zobrazenie Webhooky, na požiadanie jeden endpoint.

Kde to vidíte

V chate, v odpovedi Apexu, a vpravo, v zobrazení Webhooky.

Znovu odoslanie a opätovné spustenie sa robí tlačidlami Odoslať znova a Znova spustiť v zobrazení Webhooky; môže to urobiť Superpoužívateľ účtu alebo Administrátor.