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

Dodawanie subskrybenta

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

https://www.implebot.net/api/?uid=UID_TWOJEJ_LISTY
&email=jan@kowalski.pl
&key=DYNAMICZNIE_WYGENEROWANY_KOD
&firstname=Jan
&lastname=Kowalski
&ip=255.255.255.255
&source=xyz
Jeśli chcesz, aby subskrybent nie musiał potwierdzać subskrypcji, musisz aktywować usługę impleBOT TRUSTED na konkretnej liście. Następnie do adresu dodać: &commercialperm=0 (brak zgody na informacje handlowe, domyślne) lub &commercialperm=1 (zgoda na informacje handlowe)

Usuwanie subskrybenta

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

https://www.implebot.net/api/?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/api/?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/api/?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: aktywnyzawieszony 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/api/?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ą (w ramach jednego konta MANAGERa):

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

Kopiowanie subskrybenta

Kopiowanie sybskrybenta z jednej listy impleBOT MANAGERA na drugą (w ramach jednego konta MANAGERa):

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

UWAGA

Elementy pogrubione są obowiązkowe. Całe odwołanie/link jest jedną linią - podział na wiersze ułatwia zrozumienie.

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ć na listę autorespondera.

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 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);
$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:

$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/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/api zapisać jako: goto=http%3A%2F%2Fwww.implebot.pl%2Fpomoc%2Fapi

Zmodyfikowano 2019-10-24

Top