Spis treści 6 sekcji
ActiveCampaign API pozwala wymieniać dane między ActiveCampaign a innymi systemami bez ręcznego przenoszenia rekordów. Przydaje się przy przygotowaniu kampanii, newsletterów i automatyzacji, a także przy integracji WordPressa lub sklepu. W takich procesach osobnym zadaniem pozostaje przygotowanie szablonów wiadomości.
Planując wymianę danych, uwzględnij limit 5 żądań API na sekundę na konto1.
Czym jest API ActiveCampaign i do czego służy?
ActiveCampaign API v3 pozwala aplikacji wysyłać żądania dotyczące zasobów konta. Nie trzeba więc przenosić danych ręcznie. Przy pracy nad kampaniami i automatyzacjami zwykle zaczyna się od aktualnych danych kontaktów.
Pobranie listy kontaktów zwraca domyślnie 20 rekordów w jednej odpowiedzi2.
Żądanie API wskazuje zasób i operację, a odpowiedź API podaje wynik. Warto oddzielić odczyt od zmiany danych. Aplikacja może najpierw sprawdzić, czy rekord istnieje, a dopiero potem go zmienić.
Udany odczyt kontaktu zwraca HTTP 200, a utworzenie kontaktu przez POST /contacts – HTTP 2013.
Jakie dane kontaktów, kampanii i automatyzacji można obsługiwać przez API ActiveCampaign?
API pozwala pracować z danymi kontaktów i kampanii używanymi w marketingu. Pakiet ractivecampaign udostępnia funkcje pobierania kont, kampanii, kontaktów, transakcji oraz pól niestandardowych. Pole niestandardowe przechowuje informację zdefiniowaną przez organizację, a transakcja jest rekordem procesu sprzedażowego4.
Aby przypisać wartość pola niestandardowego, trzeba podać dwa identyfikatory: kontaktu i pola5.
Automatyzacja obejmuje reguły, które uruchamiają działania na podstawie zdarzeń lub danych. Przy połączeniu z zewnętrznym systemem warto osobno potraktować przesyłanie danych kontaktu i ustawienie reguł. Reguły korzystają później z przekazanych informacji.
Dodanie kontaktu do istniejącej automatyzacji wymaga dwóch identyfikatorów: kontaktu i automatyzacji6.
Jak wysłać żądanie do API ActiveCampaign, aby odczytać lub zmienić dane?
Aplikacja kieruje żądanie do wybranego zasobu. Operację dobiera do celu: odczytu rekordu albo przesłania zmiany. Przed zmianą kontaktu może sprawdzić, czy jego rekord już istnieje.
Jedno żądanie POST /contact/sync aktualizuje kontakt o podanym adresie e-mail lub tworzy go, jeśli adres nie występuje7.
Odczyt i zmianę danych rozróżnia cel żądania oraz sposób wykorzystania odpowiedzi:
| Operacja | Co robi aplikacja | Przykładowy wynik |
|---|---|---|
| Odczyt danych | Wskazuje zasób i sprawdza odpowiedź przed dalszym przetwarzaniem. | Udany odczyt kontaktu: HTTP 200. |
| Zmiana danych | Wskazuje rekord albo dane nowego rekordu i przygotowuje wartości pól. | Utworzenie kontaktu przez POST /contacts: HTTP 201. |
ActiveCampaign Node.js API wrapper zawiera przykłady pobrania konta, sprawdzenia kontaktu po adresie e-mail i dodania listy. Każdy przykład dotyczy innej operacji. Żądanie trzeba więc dobrać do konkretnego celu8.
Odpowiedź pozwala ocenić, czy aplikacja może użyć odczytanych danych. Po zmianie rekordu wskazuje z kolei, czy proces może przejść dalej.
Udany odczyt danych kontaktu przez GET /contacts/{id} potwierdza kod HTTP 2009.
Jak przetestować połączenie z API ActiveCampaign?
Połączenie warto przetestować przed rozpoczęciem synchronizacji. Najpierw sprawdź uwierzytelnienie, a dopiero potem żądania dotyczące kontaktów. Taka kolejność ułatwia ustalenie źródła problemu.
Kod HTTP 401 oznacza żądanie nieautoryzowane; po jego otrzymaniu sprawdź klucz API, zanim zaczniesz analizować dane kontaktu10.
- Test uwierzytelnienia można wykonać metodą credentials_test() z biblioteki Node.js dla ActiveCampaign API. Metoda sprawdza dane uwierzytelniające8.
- Test odczytu polega na wysłaniu żądania dotyczącego istniejącego zasobu i sprawdzeniu odpowiedzi.
- Test zmiany wymaga wykonania zamierzonej operacji i sprawdzenia, czy odpowiedź odpowiada przesłanemu żądaniu.
Wynik testu połączenia nie mówi jeszcze, czy odczyt lub zmiana danych się powiedzie. Każdą z tych operacji oceń osobno.
Jak interpretować błędy odpowiedzi i limity żądań API ActiveCampaign?
API informuje o niepowodzeniu w odpowiedzi na żądanie. Diagnozę zacznij od wyniku operacji i treści komunikatu. Błąd uwierzytelnienia, błędne dane rekordu i przekroczenie limitu żądań wymagają różnych działań.
Po przekroczeniu limitu API zwraca HTTP 429; wtedy należy wstrzymać kolejne wywołania1.
- Błąd uwierzytelnienia wymaga najpierw sprawdzenia danych użytych do połączenia.
- Błąd danych wymaga porównania przesłanych pól, ich wartości i wskazanego zasobu z planowaną operacją.
- Limit żądań wymaga zmniejszenia tempa wywołań i obsłużenia ponowienia po stronie integracji.
Treść odpowiedzi wskazuje, co należy poprawić. Może chodzić o dane rekordu, uwierzytelnienie albo sposób wysyłania żądań11.
Jak znaleźć adres konta i klucz API ActiveCampaign oraz ustawić uwierzytelnianie?
ActiveCampaign udostępnia adres URL API i klucz API w ustawieniach konta. Integracja używa obu wartości do uwierzytelnienia. Oficjalna biblioteka Node.js dla ActiveCampaign API wymaga aktywnego konta hostowanego w ActiveCampaign8.
Ścieżka adresu API v3 zaczyna się od /api/3; połącz ją z adresem API i kluczem właściwego konta12.
- Adres URL API odczytaj z ustawień API konta ActiveCampaign i wpisz do konfiguracji integracji.
- Klucz API odczytaj z tego samego konta i przechowuj poza publicznie dostępnym kodem aplikacji.
- Uwierzytelnianie w ractivecampaign skonfiguruj funkcją ac_auth, która ustawia adres URL i klucz API ActiveCampaign4.
Integracja powinna korzystać z adresu URL i klucza przypisanych do tego samego konta. Dopiero wtedy można oceniać wynik połączenia.
Kod HTTP 401 wskazuje brak autoryzacji i daje powód do sprawdzenia użytego klucza API10.
Gdzie znaleźć przewodniki i przykłady w dokumentacji API ActiveCampaign?
Dokumentacja API ActiveCampaign obejmuje przewodniki integracji, przykłady żądań i specyfikację operacji. Przewodnik pomaga zaplanować połączenie aplikacji z kontem. Specyfikacja API opisuje natomiast zasoby, parametry i odpowiedzi poszczególnych operacji.
W części dotyczącej paginacji znajdziesz między innymi domyślny limit 20 rekordów na stronę13.
Reference, czyli wykaz operacji API, pomaga ustalić sposób odczytu lub zmiany zasobu. Przykład pokazuje strukturę żądania, ale trzeba go dopasować do własnych danych. Przy wdrożeniu wybierz najpierw operację w specyfikacji, a potem porównaj z przykładem przygotowane żądanie.
Parametr limit w dostosowanym żądaniu może wynosić maksymalnie 10013.
Kampanie i newslettery: jak korzystać z API przy ich tworzeniu?
Przy tworzeniu kampanii API pomaga przygotować dane odbiorców i powiązać je z procesem wysyłki. Newsletter trafia do wybranej grupy kontaktów. Samo przygotowanie danych kontaktowych nie oznacza jeszcze wysłania wiadomości.
W opisanej ścieżce API v3 przygotowanie i zaplanowanie wysyłki obejmuje pięć operacji: od utworzenia kampanii po jej aktywowanie14.
- Odbiorców kampanii wybierz spośród kontaktów, które mają otrzymać newsletter. Uwzględnij ich status i zgodę na komunikację.
- Segmentację oprzyj na danych potrzebnych do danej wysyłki. Polega ona na wyborze kontaktów spełniających określone warunki.
- Szablon wiadomości przygotuj z tematem, treścią i danymi nadawcy. Oddziel treść newslettera od danych służących do wyboru odbiorców.
- Operację API dobierz w dokumentacji do planowanego działania na kampanii. Przed wysłaniem żądania dopasuj parametry do przygotowanych danych.
- Wynik żądania sprawdź w odpowiedzi API. Przed uruchomieniem wysyłki zweryfikuj jeszcze odbiorców i treść.
Przygotowanie kampanii obejmuje odrębne etapy: dane odbiorców, treść i operację wysyłki. API pomaga powiązać je w jednym procesie, ale nie zastępuje sprawdzenia wiadomości przed wysłaniem.
Synchronizacja danych ActiveCampaign z innymi systemami
API pozwala wymieniać dane z innym systemem, gdy integracja musi odczytywać lub zmieniać rekordy. Sklep może na przykład przekazywać dane klientów do kontaktów używanych w komunikacji marketingowej. Zakres synchronizacji zależy od wybranych zasobów i operacji API7.
Przy planowaniu kolejnych wywołań obowiązuje limit 5 żądań na sekundę na konto.
- Merge pozwala dynamicznie pobrać schematy danych dla integracji z ActiveCampaign z endpointu /meta. Schematy służą do przygotowania żądań POST i PATCH oraz wskazują wymaganą strukturę danych15.
- Looping w Zapier można wykorzystać do wykonania wielu żądań dotyczących tagów ActiveCampaign przez API. Tag to oznaczenie przypisane do kontaktu, które pomaga organizować dane odbiorców16.
Synchronizacja wymaga dopasowania struktury danych do operacji API. Integracja musi też obsłużyć kolejne żądania, z uwzględnieniem limitu 5 na sekundę na konto.
Źródła
- ↑ActiveCampaign — Rate Limits https://developers.activecampaign.com/reference/rate-limits
- ↑ActiveCampaign — List, search, and filter contacts https://developers.activecampaign.com/reference/list-all-contacts
- ↑ActiveCampaign — Create a contact https://developers.activecampaign.com/reference/create-a-new-contact
- ↑ractivecampaign: Loading Data from 'ActiveCampaign API v3′ https://cran.r-project.org/web/packages/ractivecampaign/ractivecampaign.pdf
- ↑ActiveCampaign — Set a contact custom field value https://developers.activecampaign.com/reference/create-fieldvalue
- ↑ActiveCampaign — Add a contact to an automation https://developers.activecampaign.com/reference/create-new-contactautomation
- ↑dokumentacja ActiveCampaign, „Create or update a contact by email (upsert)” https://developers.activecampaign.com/reference/sync-a-contacts-data
- ↑activecampaign-api-nodejs/README.md at master · ActiveCampaign/activecampaign-api-nodejs https://github.com/ActiveCampaign/activecampaign-api-nodejs/blob/master/README.md
- ↑ActiveCampaign — Retrieve a contact https://developers.activecampaign.com/reference/get-contact
- ↑ActiveCampaign — Retrieve a Segment https://developers.activecampaign.com/reference/retrieve_segment
- ↑dokumentacja ActiveCampaign, „Bulk import contacts”; „Update a Segment” https://developers.activecampaign.com/reference/bulk-import-contacts
- ↑ActiveCampaign — Base URL https://developers.activecampaign.com/reference/url
- ↑ActiveCampaign — Pagination, Ordering, and Filtering https://developers.activecampaign.com/reference/pagination
- ↑ActiveCampaign — API Examples Using campaign_create https://www.activecampaign.com/api/example.php?call=campaign_create
- ↑ActiveCampaign API Integration – Build & Ship Faster with Merge https://www.merge.dev/integrations/activecampaign
- ↑ActiveCampaign Adding/Removing Multiple Tags Using API | Zapier Community https://community.zapier.com/code-webhooks-52/activecampaign-adding-removing-multiple-tags-using-api-25125
Ceny i warunki sprawdzone u źródeł: październik 2026.