Ecomail oferuje API do własnych integracji i innych rozwiązań przy pracy z kontaktami i listami kontaktów.
Dzięki połączeniu Ecomailu za pomocą API łatwo zintegrujesz własne rozwiązanie z naszą aplikacją, osiągniesz bardziej zaawansowane scenariusze, skonfigurujesz własne formularze, wiadomości transakcyjne lub inne cele.
UWAGA ⚠️ Żądania muszą być wysyłane jako JSON payload z nagłówkiem:
Content-Type: application/json
Więcej o formacie JSON przeczytasz tutaj. Konkretne przykłady znajdziesz w naszej dokumentacji API.
Dokumentacja API Ecomail
W tym artykule znajdziesz:
1. Jakie możliwości oferuje API
Listy kontaktów
Parametr trigger_autoresponders umożliwia uruchomienie automatyzacji z wyzwalaczem Zapisał się na listę
Zawsze należy przesyłać wszystkie tagi, które kontakt ma posiadać
Za pomocą parametru update_existing można zaktualizować istniejący kontakt
Kontakty
Na podstawie adresu e-mail
Trwale usuwa kontakt i wszystkie jego dane z bazy
Kampanie
Automatyzacje
Na podstawie ID automatyzacji i adresu e-mail kontaktu
Szablony
Domeny
E-maile transakcyjne
Transakcje (zamówienia)
Aby jak najlepiej zarządzać transakcjami w aplikacji, pracuj z nazwą sklepu
Zaktualizowanie konkretnej transakcji – na podstawie jej ID
Usunięcie konkretnej transakcji – na podstawie jej ID
Feedy produktowe
Feedy danych
Zdarzenia własne
Wysłanie własnego zdarzenia (np. porzucony koszyk)
Więcej informacji o wysyłaniu zdarzeń znajdziesz tutaj
Wyszukiwanie kontaktów
Kupony rabatowe
2. Jak skonfigurować połączenie z API
Aby korzystać z API, potrzebujesz klucza API Twego konta Ecomail. Klucz ten znajdziesz po zalogowaniu do aplikacji → Zarządzaj kontem → Dla deweloperów → Klucz API.
Jest on widoczny tylko dla użytkowników z uprawnieniami administratora.
Dokumentację API znajdziesz pod adresem: https://docs.ecomailczv2.apiary.io/
Może się zdarzyć, że będziesz musiał wygenerować nowy klucz API. Nowy klucz API wygenerujesz, klikając przycisk „Odśwież klucz API” obok aktualnego klucza.
⚠️ Po zmianie nie będzie już możliwe korzystanie ze starego klucza API.
Pamiętaj, aby zaktualizować klucz we wszystkich swoich integracjach z Ecomail, aby mogły nadal działać poprawnie.
Ponieważ łączenie przez API jest bardziej wymagające technicznie, zalecamy skontaktowanie się z Twoim technikiem w celu uzyskania opcji konfiguracji. Sprawdź również, czy mamy już gotową integrację z Twoim systemem lub czy możliwe jest połączenie aplikacji za pomocą usług Zapier lub Make.
3. Często zadawane pytania (FAQ)
Jak sprawdzić, czy API zostało poprawnie podłączone?
Wykonaj testowe zamówienie lub rejestrację kontaktu. Zmiany będą widoczne na liście kontaktów.
Czy API ma jakieś ograniczenia?
Tak – limit API to 1 000 zapytań na minutę. Po jego przekroczeniu zapytania zostaną odrzucone z kodem statusu 429 oraz nagłówkiem Retry-After.
W jakim pakiecie można korzystać z API?
API dostępne jest w każdym pakiecie taryfowym.
Zaawansowane funkcje, takie jak transakcje, e-maile transakcyjne czy zaawansowana segmentacja, są dostępne tylko w pakiecie Marketer.
Gdzie znajdę ID listy kontaktów?
W niektórych zapytaniach API wymagane jest podanie ID listy kontaktów w formie liczbowej (np. przy zapytaniu o dodanie nowego kontaktu).
ID listy kontaktów znajdziesz w pasku URL przeglądarki w momencie, gdy masz otwartą daną listę w aplikacji:
Wszystkie listy oraz ich identyfikatory (ID) możesz także pobrać za pomocą tego endpointu API: https://ecomailczv2.docs.apiary.io/#reference/lists/list-collections/view-all-lists
❓
Jeśli masz pytania, napisz do nas na [email protected]