API i webhooki
Dzięki API Państwa CRM, sklep internetowy lub drukarnia pracują bezpośrednio z Trendizz: przekazują chronionych klientów i wykluczenia, odbierają firmy z pozytywną odpowiedzią i adresy kampanii pocztowych, pobierają raport kampanii, a przez webhooki od razu dowiadują się o zdarzeniach. Apex wyjaśnia konfigurację i na podstawie dziennika mówi, co się stało. Kluczami i webhookami zarządza Superużytkownik konta lub Administrator.
Odpowiedź Apexa pochodzi z jego wiedzy i z dziennika konta. Adres jest zmyślony.
Podłączenie krok po kroku
Apex przeprowadza przez pięć najczęstszych podłączeń. Dokładne wywołania i przykłady kodu są w dokumentacji dla programistów, do każdego osobny przewodnik.
- Co się dzieje
- Apex podaje kroki: Państwa system przekazuje klienta, który się rejestruje lub subskrybuje, jako chronionego klienta pod jego własnym identyfikatorem, obecnych klientów paczkami, do 10 000 w jednym wywołaniu, a rezygnującego usuwa, dzięki czemu można się z nim znów kontaktować. Przy adresie firmowym dobrym wyborem jest domena, przy darmowym dostawcy poczty (na przykład gmail.com) sam adres e-mail.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa. Klucz tworzy się w menu konta, w pozycji API i webhooki, w widoku Klucze.
Chronionemu klientowi żadna kampania nie pisze, także ta skierowana do obecnych klientów. Tych, do których chcą Państwo pisać, na przykład w kampanii ponownych zakupów, ładuje się do kampanii i nie oznacza jako chronionych.
- Co się dzieje
- Apex omawia kroki: system drukarni prosi o eksport adresów kampanii, tylko nowych albo wszystkich, duży eksport czyta stronami, a po nadaniu na poczcie zgłasza dla każdej firmy dzień nadania. Do stanu „Nadane” może przejść tylko firma „Po eksporcie”.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa.
To ten sam eksport, co w interfejsie, i pojawia się też w Moich eksportach. Klucz testowy w każdym pakiecie zwraca adresy przykładowe.
- Co się dzieje
- Apex wyjaśnia, że w widoku Webhooki trzeba dodać nowy endpoint z adresem CRM i zaznaczyć zdarzenie Pozytywna odpowiedź. Sekret podpisu programista dostaje jednorazowo i go zapisuje. Jeśli CRM przez pewien czas był niedostępny, pobranie firm z pozytywną odpowiedzią uzupełnia to, co w międzyczasie przepadło.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa. Endpoint dodaje się w menu konta, w pozycji API i webhooki, w widoku Webhooki.
Ten webhook przekazuje także kontakt, dlatego każde jego doręczenie jest eksportem i pojawia się też w Moich eksportach.
- Co się dzieje
- Apex podaje cztery kroki: programista czyta surową treść, liczy podpis HMAC-SHA256 ze znacznika czasu i treści z sekretem endpointu, porównuje go w stałym czasie z wartością v1 nagłówka Trendizz-Signature i odrzuca żądanie starsze niż 5 minut. Przykłady kodu są w dokumentacji.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa.
- Co się dzieje
- Apex wyjaśnia, że potrzebny jest klucz raportowy, z nazwą agencji. Ten klucz tylko odczytuje konto i raport kampanii, w sumach oraz w podziale dziennym, tygodniowym lub miesięcznym, niczego nie może zapisać i można go unieważnić pojedynczo. Agencja używa go na Państwa zlecenie we własnym systemie lub arkuszu.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa. Klucz tworzy się w menu konta, w pozycji API i webhooki, w widoku Klucze.
Raport podaje tylko liczby, bez firm i danych kontaktowych. Liczby są te same, co na stronach kampanii w Trendizz.
Dziennik wywołań i webhooki
Apex czyta dziennik wywołań i doręczenia webhooków, mówi, co się stało, i otwiera odpowiedni widok.
- Co się dzieje
- Apex czyta dziennik wywołań i mówi, co się stało, kiedy, którym kluczem i w czyim imieniu: udane wywołania, a przy błędach znaczenie kodu błędu. Na życzenie otwiera widok Dziennik wywołań.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa, oraz po prawej, w widoku Dziennik wywołań w API i webhookach.
Pełną odpowiedź wywołania, przez które wyszły dane, może otworzyć tylko twórca klucza; Superużytkownik i Administratorzy, jeśli to nie oni utworzyli klucz, widzą podsumowanie: ile firm i jakie pola wyszły.
- Co się dzieje
- Apex czyta endpointy webhooków i doręczenia: co wyszło, kiedy, co odpowiedział endpoint, a jeśli endpoint zawodzi lub jest zawieszony, dlaczego. Otwiera widok Webhooki, na życzenie jeden endpoint.
- Gdzie to widać
- W czacie, w odpowiedzi Apexa, oraz po prawej, w widoku Webhooki.
Ponowne wysłanie i ponowne uruchomienie wykonuje się przyciskami w widoku Webhooki; może to zrobić Superużytkownik konta lub Administrator.
Warto wiedzieć
Chroniony klient
Chronionemu klientowi żadna kampania nie pisze. Tych, do których chcą Państwo pisać, ładuje się do kampanii; jako chronionych oznacza się tych, których wolą Państwo zostawić w spokoju.
Klucz testowy i produkcyjny
Kluczem testowym w każdym pakiecie każde wywołanie zachowuje się jak na produkcji, ale nic się nie zmienia, a przy odczycie przychodzą dane przykładowe. Klucz produkcyjny działa w pakiecie płatnym. Klucze tworzą Superużytkownik konta i Administratorzy; klucz raportowy tylko odczytuje konto i raporty kampanii.
Jednolity limit
W każdym pakiecie 1000 wywołań na firmę na godzinę, osobno dla klucza testowego i produkcyjnego.
Wszystko w dzienniku
Każde wywołanie i każdy webhook jest w dzienniku: kiedy, którym kluczem, o co poproszono i co przyszło. Szczegóły są widoczne dla Superużytkownika i Administratorów przez 90 dni.
Proszę wypróbować za darmo.
Proszę zapytać Apex. Odpowiada na Państwa koncie, z myślą o Państwa firmie.