API

API umożliwi Ci automatyzację działań związanych z gromadzeniem w platformie ExpertSender danych o zachowaniach zakupowych Twoich klientów oraz zamówieniach.

Jaki zdarzenia obsłużysz przez ExpertSender API?

Z pomocą ExpertSender API zautomatyzujesz:

• Dodawanie nowych klientów do Twojej bazy w platformie,
• Modyfikowanie danych klientów, którzy już znajdują się w Twojej bazie danych w ExpertSender,
• Rejestrację zamówień dokonanych przez klientów i zmianę statusów tych zamówień,
• Dodawanie zdarzeń niestandardowych w scenariuszach.

Adres serwera API

Struktura adresu jest jednakowa dla wszystkich endpointów: https://api.ecdp.app/xxx

gdzie xxx to nazwa konkretnego endpointu, np. orders, customers, scenariocustomevents.

Dokładne adresy znajdziesz przy opisach każdej używanej przez nas metody API.

Klucz API – uwierzytelnianie

Klucz API służy do uwierzytelniania wywołań i żądań wychodzących aplikacji zewnętrznych, przez które pozyskujesz dodatkowe dane o zachowaniu Twoich klientów, a które następnie przesyłasz do platformy ExpertSender.

Każda jednostka biznesowa stworzona w ExpertSender posiada własny klucz API. Znajdziesz go tutaj: Ustawienia > API. Wystarczy, że skopiujesz go do schowka i udostępnisz w aplikacji lub kliencie, przez które wysyłasz żądania API.

Jeśli obsługujesz kilka jednostek biznesowych w ramach jednej organizacji, każda z jednostek będzie miała przypisany unikalny klucz API.

Jak korzystać z ExpertSender API?

Z naszego API skorzystasz za pośrednictwem przeznaczonych do tego aplikacji (klientów).

Jaka aplikacja będzie najlepsza? Ta, z której już korzystasz.

Wystarczy, że dodasz do niej klucz API Twojej jednostki biznesowej i wyślesz zapytanie o interesujące Cię dane, czyli tak zwane żądanie API (API request). Musisz podać klucz API w każdym zapytaniu, które wyślesz do ExpertSender API.

Żądanie API jest częścią składową wywołania API (API call), które obejmuje też przetworzenie żądania przez serwer otrzymujący, np. platformę ExpertSender, oraz odesłanie wyników w postaci poszukiwanego przez Ciebie zestawu danych.

W naszym API używamy danych w formacie JSON i XML.

Można wykonać maksymalnie 8 jednoczesnych połączeń z naszym API.

Wywołanie API – API call

Żeby zapytanie o dane było skuteczne, żądanie API musi trafić pod odpowiedni adres (endpoint), mieć odpowiednią składnię oraz musi być zrealizowane za pomocą tzw. metod.

Dla każdej metody obowiązuje inna składnia. Poniżej znajdziesz listę metod wraz z linkami prowadzącymi do adresów i opisów zawierających wspomniane składnie.

Metody API

Stosujemy następujące metody:

1. Klienci:
   • POST – dodawanie informacji o nowym kliencie.
   • GET {id} – pozyskiwanie informacji o kliencie po przypisanym do niego numerze ID.
   • GET {email} – pozyskiwanie informacji o kliencie po przypisanym do niego adresie e-mail.
   • GET {phone} – pozyskiwanie informacji o kliencie po przypisanym do niego numerze telefonu.
   • GET {crmId} – pozyskiwanie informacji o kliencie po przypisanym do niego numerze CRM ID.
2. Zamówienia:
   • POST – dodawanie informacji np. o nowym zamówieniu.
   • GET – pozyskiwanie informacji o zamówieniu po numerze zamówienia.
   • PUT – aktualizowanie statusu zamówienia
   • DELETE – zmiana statusu zamówienia na Usunięty (IsDeleted).
3. Zdarzenia niestandardowe w scenariuszach:
   • POST — dodawanie informacji o kliencie lub zamówieniu pozyskanym w drodze niestandardowego zdarzenia, np. zakup w sklepie stacjonarnym z użyciem karty lojalnościowej.
4. Pobieranie listy cech klientów:
   • GET — pozyskiwanie kompletnej listy cech klientów. Lista ta nie będzie zawierać cech systemowych, a jedynie cechy zdefiniowane przez Ciebie w sekcji Ustawienia > Klienci > Cechy klientów.
5. Pobieranie listy zgód:
   • GET — pobieranie kompletnej listy zgód na komunikację udzielonych przez Twoich klientów.
6. Pobieranie listy cech zamówień:
   • GET — pobieranie kompletnej listy cech zamówień. Lista ta nie będzie zawierać cech systemowych, a jedynie cechy zdefiniowane przez Ciebie w sekcji Ustawienia > Zamówienia > Cechy zamówienia.
7. Pobieranie listy cech produktów:
   • GET — pobieranie kompletnej listy cech produktów. Lista ta nie będzie zawierać cech systemowych, a jedynie cechy zdefiniowane przez Ciebie w sekcji Ustawienia > Zamówienia > Cechy produktów.

Kody odpowiedzi na zapytanie API

Wysyłając zapytanie API dowolną metodą otrzymasz odpowiedź serwera wraz z numerem kodu. Najczęściej spotykane odpowiedzi na zapytanie API to:

Kody odpowiedzi mogą być różne dla poszczególnych metod, dlatego pod każdą z nich umieszczamy zestaw kodów dla niej właściwy.