API (metoda GET)

Dodawanie i Zarządzanie subskrybentami z Twojego serwera

Możesz zmienić sposób zapisu Twoich subskrybentów na listę adresową. Jeżeli nie wiesz, o co w tym chodzi pozostaw włączoną opcje POST – oznaczającą zapis na podstawie formularza.

Dodawanie subskrybentów metodą GET jest domyślnie wyłączone, można to zmienić w zakładce Ustawienia > Dodawanie subskrybentów.

Jest to opcja zaawansowana, przeznaczona dla osób, które chcą zintegrować swojš listę adresową z e-sklepem lub innym systemem e-biznesowym.

 

UWAGA: Stare parametry w j. polskim (imie, nazwisko, pole_1 itd.) nadal działają i będą działać.

Dodawanie subskrybenta

Opcja ta pozwala wpisać nowego subskrybetna na listę za pomocą odwołania
www w postaci:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&firstname=Jan
&lastname=Kowalski
&ip=255.255.255.255
&source=xyz

Usuwanie subskrybenta

Jeśli chcesz usunąc subskrybetna za pomocą odwołania www, adres wygląda tak:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&r=1
&r_mail=1

Sprawdzanie statusu subskrybenta

Jeśli chcesz sprawdzić status subskrybenta, adres wygląda tak:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&c=1

Jeśli subskrybent jest na liście, otrzymasz komuniakt:

OK:stauts:data_unixowa_zapisania_sie:data_unixowa_potwierdzenia

Edycja danych subskrybenta

Jeśli chcesz edytować subskrybetna za pomocą odwołania www, adres wygląda tak:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&e=1
&custom_1=nowe_pole_1
&custom_2=nowe_pole_2
&custom_3=nowe_pole_3
&custom_4=nowe_pole_4
&custom_5=nowe_pole_5
&source=nowe_zrodlo
&status=KOD
&lastmessage=ID_WIADOMOSCI_AUTORESPONDERA

W odwołaniu użyj tylko tych parametrów (custom_X, zrodlo, status, lastmessage), które chcesz zmienić.

KOD statusu to:

  • 0 – zawieszony – nie otrzymuje żadnych maili
  • 1 – aktywny – otrzymuje maile z kolejki autorespondera oraz mailingi
  • 2 – koniec – może otrzymywać tylko mailingi

ID_WIADOMOSCI_AUTORESPONDERA to identyfikator AKTYWNEJ wiadomości z kolejki (znajdziesz go pod informacją o opóźnieniu danego maila), która ma zostać ustawiona, jako ostatnio wysłana do subskrybenta. Oznacza to, że otrzyma kolejną wiadomość, po tej wiadomości.

Edycja jest tylko u subskrybentów ze statusem: aktywny, zawieszony lub koniec.

Zawieszanie / Odwieszanie / Blokowanie kolejki autorespondera konkretnego subskrybenta

UWAGA: Polecamy skorzystać z opcji EDYCJA danych do zmiany statusu. Zwracamy uwagę, że KOD w tym przypadku ma INNE wartości, niż przy zmianie statusu za pomocą EDYCJI danych.

Jeśli chcesz zawiesić, odwiesić lub zmienić status na “koniec” subskrybenta za pomocą odwołania www, adres wygląda tak:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&s=KOD

KOD może mieć następujące postaci – UWAGA, :

  • 1 – zawieszenie subskrybenta, który ma status AKTYWNY lub KONIEC
  • 2 – odwieszenie / aktywowanie subskrybenta, który ma status ZAWIESZONY lub KONIEC
  • 3 – zmiana statusu na koniec u subskrybenta, który ma status AKTYWNY lub ZAWIESZONY

Status zawieszony oznacza, że subskrybent nie może dostać żadnej wiadomości – ani z autorespondera, ani z mailingu. Samodzielnie może się tylko wypisać.

Status koniec oznacza, że subskrybent nie dostaje wiadomości autorespondera, ale może otrzymać mailing (jeśli uwzględnimy takie osoby w filtrze do mailingu)

Przenoszenie subskrybenta

Przenoszenie sybskrybenta z jednej listy impleBOT MANAGERA na drugą:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&mv=UID_LISTY_DOCELOWEJ
&key2=DYNAMICZNIE_WYGENEROWANY_KOD_DOCELOWEJ_LISTY

Z oznacza UID listy docelowej a ZZZZZZ jest to kod weryfikacyjny dla listy docelowej wyliczony z adresu email i kodu tajnego listy docelowej

Kopiowanie subskrybenta

Kopiowanie sybskrybenta z jednej listy impleBOT MANAGERA na drugą:

https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&cp=UID_LISTY_DOCELOWEJ
&key2=DYNAMICZNIE_WYGENEROWANY_KOD_DOCELOWEJ_LISTY

Z oznacza UID listy docelowej a ZZZZZZ jest to kod weryfikacyjny dla listy docelowej wyliczony z adresu email i kodu tajnego listy docelowej

UWAGA

Elementy czerwone są obowiązkowe. Normalnie całe odwołanie jest jedną linią. Tutaj je podzieliłem dla porządku.

Elementy obowiązkowe:

  1. https://www.implebot.net/get.php – ścieżka skryptu odpowiedzialnego
    za dodawanie metodą GET.
  2. ?uid=UID_TWOJEJ_LISTY – to identyfikator konta impleBOT/FreeBOT, na który ma być wpisana
    osoba. Zmienna kod (za chwilę) dodatkowo gwarantuje, że nie jest możliwe wpisanie kogoś na cudzą listę.
  3. &email=jan@kowalski.pl – adres e-mail osoby wpisywanej na listę.
  4. &key=DYNAMICZNIE_WYGENEROWANY_KOD – dynamicznie generowany
    kod, który weryfikuje, czy z metody korzysta właściciel danego autorespondera. Kod jest generowany z adresu e-mail
    subskrybenta i specjalnego kodu, który wygenerowaliśmy dla Ciebie podczas rejestracji.Aby wygenerować zmienną kod w PHP, użyj poniższego skryptu:
<?php
 $key = MD5($email."SEKRETNY_KOD_TWOJEJ_LISTY");
?>

Czerwony fragment zamień na Twój unikalny kod, który znajdziesz w panelu w zakładce Ustawienia > Dodawanie subskrybentów. Nikomu go nie ujawniaj, ponieważ z jego pomocą
obce osoby będą mogły dodawać na Twoją listę najróżniejsze adresy e-mail, a Ty zostaniesz
posiądzony o spam!

Zmienną $email zastąp zmienną, która w Twoim systemie zawiera adres e-mail osoby, którą chcesz wpisać na listę autorespondera.

  • &r=1 – jeśli chcesz, aby dany subskrybent został WYPISANY z listy, dodaj ten parametr.

 

Elementy opcjonalne:

  1. &firstname=Jan – imię osoby wpisywanej na listę.
  2. &lastname=Kowalski – nazwisko osoby wpisywanej na listę.
  3. &ip=255.255.255.255 – adres IP osoby wpisywanej na listę. Adres IP osoby odwiedzającej
    Twoją stronę jest zapisany w zmiennej $REMOTE_ADDR.
  4. &source=xyz – źródło adresu. Zdefiniowanie źródła pozwoli
    Ci śledzić, skąd są dane osóby na Twojej liście. Źródło nie może zawierać polskich znaków i
    spacji.
  5. &r_mail=1 – jeśli ustawiłeś parametr r=1, ta zmienna powoduje wysłanie potwierdzenia rezygnacji do usuwanego z listy subskrybenta.
  6. &custom_1=Jakaś_informacja – dodatkowe informacje, patrz Personalizacja.
  7. &custom_2=, &custom_3=, &custom_4=, &custom_5= – jw., analogicznie.

Skrypt metody GET zwraca dwie podstawowe informacje (kodowanie ISO-8859-2):

  1. OK – w przypadku prawidłowego wykonania polecenia.
  2. ERROR:Opis błędu – w przypadku błędu.

Aby dodać subskrybenta za pomocą metody GET, należy w PHP skorzystać z CURL:

<?php
$key = MD5($email."SEKRETNY_KOD_TWOJEJ_LISTY");
$url = "https://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY&email=$email&key=$key&firstname=$lastname";
$ch = curl_init();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
$file = curl_exec($ch);
curl_close($ch);
?>

Metoda CURL pozwala łatwo odczytać treść komunikatu wysyłanego przez skrypt get.php. Komunikat ten znajduje się w zmiennej $file w przypadku korzystania z powyższego kodu. Następnie wystarczy rozbić komunikat na dwukropku “:” aby uzyskać informacje typu OK/ERROR i ew. opis błędu, konkretnie:

<?php
$komunikat = explode(":", $file);
$wynik = $komunikat[0]; // OK lub ERROR
$komunikat = $komunikat[1]; // opis bledu
?>

Uwaga: niektóre serwery mogą nie pozwolić na skorzystanie z CURL. Wtedy można np.
wywołać adres jako “obrazek” gdzieś na wyświetlanej nam albo subskrybentowi stronie:

<img src="http://www.implebot.net/get.php?uid=UID_TWOJEJ_LISTY..." height=1 width=1 border=0>