Pierwsza integracja z API

Co możesz zbudować

Po zapisie lub zakupie w sklepie, formularzu albo CRM zarejestruj adres e-mail klienta w Apresly. Odpowiedź zawiera termin kampanii, spersonalizowane linki do oferty oraz, jeśli został skonfigurowany, obraz licznika do e-maila. Przekaż te wartości do swojego narzędzia do wysyłki.

API jest dostępne w każdym planie. Dostępność zasobów licznika nadal zależy od narzędzi na Twoim koncie. Obecne integracje mailowe działają równolegle.

1. Przygotuj opublikowaną kampanię

W Apresly skonfiguruj strony kampanii, licznik, strefę czasową i zachowanie po wygaśnięciu. Opublikuj kampanię. Na stronie oferty zainstaluj widget Apresly, który egzekwuje wygaśnięcie.

API działa na prawdziwych danych, bez osobnego sandboxa. Test rejestracji tworzy rzeczywistego leada i może uruchomić rzeczywisty termin. Użyj własnej kampanii i adresu e-mail. Przed wykonaniem przykładów zastąp przykładowy e-mail i ID kampanii.

2. Utwórz i zapisz klucz API

Otwórz ustawienia API, dostępne też w Integracje → API. W zakładce Klucze wybierz Utwórz klucz i nadaj mu rozpoznawalną nazwę, np. „Integracja sklepu”. Od razu skopiuj sekret: zostanie pokazany tylko raz.

Zapisz go jako APRESLY_API_KEY w zmiennej środowiskowej serwera albo prywatnym połączeniu narzędzia automatyzacji. Przykłady poniżej odczytują tę zmienną. Wysyłaj klucz w nagłówku Authorization: Bearer <YOUR_API_KEY>. Każdy klucz ma dostęp do wszystkich kampanii swojego konta. Nie umieszczaj go w JavaScripcie strony, adresach URL, publicznym repozytorium ani logach.

3. Wybierz kampanię

Pobierz listę opublikowanych kampanii:

curl --fail-with-body "https://app.apresly.com/api/public/v1/campaigns?isDraft=false&limit=50" \
  -H "Authorization: Bearer $APRESLY_API_KEY"

W kolejnych żądaniach użyj id z tablicy items. Wartość 42 jest przykładowa. Jeśli nextAfterId nie jest null, przekaż ją jako afterId, aby pobrać kolejną stronę.

4. Zarejestruj testowego leada

Po zdarzeniu, które ma wprowadzić leada do kampanii, wyślij POST:

curl --fail-with-body -X POST "https://app.apresly.com/api/public/v1/campaigns/42/leads" \
  -H "Authorization: Bearer $APRESLY_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"email":"[email protected]","language":"pl"}'

Nowy logiczny lead zwraca 201 i created: true. Istniejący lead zwraca 200 i created: false. W obu przypadkach obowiązują zasady rejestracji i licznika ustawione w kampanii.

Do przycisku oferty w e-mailu użyj offerLinks[].url, wybierając właściwą stronę przez pageId. Jeśli otrzymasz mailTimerUrl, wykorzystaj go jako źródło obrazu w e-mailu. Wysyłkę wykonuje Twoja platforma mailowa, Apresly nie wysyła wiadomości przez API. Puste linki i null zamiast licznika mogą oznaczać udaną rejestrację: sprawdź warnings przed mapowaniem wartości.

5. Odczytaj ofertę przed przypomnieniem

Lookup pobiera istniejącą ofertę bez ponownej rejestracji, aktywacji licznika i uruchamiania nowego cyklu:

curl --fail-with-body -X POST "https://app.apresly.com/api/public/v1/campaigns/42/leads/lookup" \
  -H "Authorization: Bearer $APRESLY_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"email":"[email protected]","language":"pl"}'

Istniejący lead zwraca 200. Brak rejestracji tego e-maila w kampanii daje 404 / LEAD_NOT_FOUND. Lookup może zwrócić wygasły termin. Przed wysłaniem przypomnienia sprawdź deadline, warnings i dostępność linków.

Co dalej

• Dokumentacja API: endpointy, pola, stronicowanie i limity.
• Make lub Zapier: podłączenie automatyzacji.
• Własny backend: przykład w Node.js.
• Rozwiązywanie problemów: błędy i brakujące zasoby.