API

Włączenie API

Dodawanie/usuwanie i modyfikacja subskrybentów za pomocą API 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ć swoja listę adresową z e-sklepem lub innym systemem e-biznesowym.

Jeśli korzystasz ze starego API (metoda GET) i wystarczy Ci jego funkcjonalność, możesz robić to nadal. Stare API nie będzie już rozwijane.

dodawanie suksbrybentów api impleBOT dodawanie sukskrybetnów metodą get impleBOT

Informacje podstawowe

W poniższych przykładach pogrubiliśmy obowiązkowy fragment odwołania. Reszta jest opcjonalna. Całe odwołanie/link jest jedną linią - podział na wiersze ułatwia zrozumienie. UWAGA: Maksymalna długość całego adresu to 2048 znaków.

Elementy obowiązkowe w każdym odwołaniu:

  1. https://www.implebot.net/api - ś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:
$key = MD5($email."SEKRETNY_KOD_TWOJEJ_LISTY");

SEKRETNY_KOD_TWOJEJ_LISTY 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ć/aazarządzać na liście autorespondera.

API zwraca dwie podstawowe informacje (kodowanie UTF-8):

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

Aby dodać subskrybenta za pomocą API, najlepiej skorzystać z CURL. Przykład dla PHP:

$key = MD5($email."SEKRETNY_KOD_TWOJEJ_LISTY");
$url = "https://www.implebot.net/api?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);
$response = curl_exec($ch);
curl_close($ch);

Metoda CURL pozwala łatwo odczytać treść komunikatu zwróconego przez API. Komunikat ten znajduje się w zmiennej $resposne 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:

$response = explode(":", $response);
$result = $response[0]; // OK lub ERROR
$response = $response[1]; // opis bledu

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

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

Automatyzacja - przekierowanie subskrybenta na wskazaną stronę:

Jeśli dodasz do zapytania parametr goto=ADRES-STRONY-DOCELOWEJ to API zamiast wyświetlić potwierdzenia operacji, przekieruje subskrybenta na wskazany adres. Pozwala to wdrożyć w impleBOT zaawansowane reguły automatyzacji BEZ programowania.

UWAGA: Koniecznie ADRES_STRONY_DOCELOWEJ zakoduj za pomocą darmowego narzędzia typu URL Encode - np. adres: goto=http://www.implebot.pl/pomoc/apizapisać jako: goto=http%3A%2F%2Fwww.implebot.pl%2Fpomoc%2Fapi

Możliwe operacje

  1. Dodawanie subskrybenta
  2. Usuwanie subskrybenta
  3. Sprawdzanie statusu subskrybenta
  4. Edycja danych subskrybenta
  5. Przenoszenie subskrybenta
  6. Kopiowanie subskrybenta

Zmodyfikowano 3 weeks ago (2020-01-24)

Top