Jak korzystać z ECDP API
Zanim zaczniesz korzystać z API ECDP, zapoznaj się z podstawowymi wymaganiami dotyczącymi adresów, uwierzytelniania, nagłówków oraz formatu żądań i odpowiedzi. Poniższe informacje obowiązują we wszystkich metodach API i s punktem wyjścia do tworzenia poprawnych zapytań.
Jaki zdarzenia obsłużysz przez ExpertSender API?
Z pomocą ExpertSender API zautomatyzujesz:
- Dodawanie nowych klientów do Twojej bazy w platformie,
- Zmianę danych klientów znajdujących się w Twojej bazie,
- Rejestrację zamówień klientów i zmianę statusów tych zamówień,
- Dodawanie zdarzeń niestandardowych w scenariuszach.
- Eksport danych klientów z wybranych segmentów.
Jak korzystać z ECDP API?
Do korzystania z API potrzebujesz aplikacji (klienta), z której możesz wysyłać zapytania. Najlepiej wybrać tę, z której już korzystasz.
Dodaj do niej klucz API swojej jednostki biznesowej i wyślij żądanie (API request) o potrzebne dane. Każde żądanie musi zawierać Twój klucz API.
Żądanie jest częścią wywołania API (API call), które obejmuje także przetworzenie go przez serwer oraz zwrócenie wyników w postaci danych.
Adres bazowy
Wszystkie endpointy korzystają z adresu bazowego:
https://api.ecdp.app/{resource}
Tutaj {resource}
to nazwa sekcji API, na przykład: orders
, customers
lub scenariocustomevents
.
Klucz API – uwierzytelnianie
Każda jednostka biznesowa ma własny klucz API. Swój klucz znajdziesz w aplikacji ExpertSender w sekcji: Ustawienia > API.
Jeśli zarządzasz kilkoma jednostkami biznesowymi, każda z nich ma przypisany unikalny klucz API.
Format żądań i odpowiedzi
- Wszystkie treści żądań muszą być zapisane w formacie JSON.
- Wszystkie odpowiedzi są zwracane w formacie JSON.
Każde żądanie musi zawierać poniższy nagłówek:
x-api-key: {your-api-key}
Nagłówki (headers)
Każde żądanie musi zawierać:
- x-api-key: {your-api-key}
- Content-Type: application/json
Kody odpowiedzi
Wysyłając zapytanie API dowolną metodą otrzymasz odpowiedź serwera wraz z numerem kodu. Najczęściej spotykane odpowiedzi na zapytanie API to:
Kod | Wiadomość | Opis |
200 | Success | zapytanie zostało przetworzone, serwer zwrócił odpowiedź |
201 | Created | żądanie zostało utworzone |
400 | Bad request | żądanie nie zostało przetworzone. Powodem jest zwykle brakujący lub nieprawidłowy parametr, jak email, phone itp. |
401 | Unauthorized | w żądaniu brakowało klucza API lub prosisz o dostęp do informacji, do których nie masz uprawnień |
403 | Forbidden | zapytanie jest poprawne, ale pytasz o dane, do których nie masz uprawnień |
404 | Not found | na serwerze nie ma danych, których szukasz |
500 | Internal server error | nieoczekiwany błąd serwera. Nic nie musisz robić, zajmiemy się tym |
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.
Logi API
Wszystkie zarejestrowane zapytania API związane z jednostką biznesową, którą zarządzasz znajdziesz w Ustawienia > Logi > Logi API.
Logi API przechowywane są w systemie przez 1 miesiąc.