Jak działa API Benefitera i co umożliwia?
Wyświetleń: 1753
|
Dodano: 29.05.2011
Co to jest API 1.0 Benefiter.pl?
Z angielskiego Application Programming Interface - interfejs programowania aplikacji. To specyficzny sposób wymiany danych poprzez aplikacją programisty a platformą benefiter.pl. W skrócie można powiedzieć, iż jest to zbiór komend przesyłanych przez programistę na specjalny adres URL API Benefitera, który następnie w zależności od zapytania reaguje przedstawiając wybrane dane.
Za pomocą API Benefitera możemy dodawać lub kasować adresy email, również sprawdzać czy dany adres jest już na liście.
Uwaga. W ciągu doby możesz zaimportować maksymalnie 2500 adresów. Dodatkowo, każdy email otrzyma wiadomość z prośbą o potwierdzenie. Istnieje możlwiość importu Twojej listy bez wysyłania potwierdzeń - usługę wykonuje konsultant benefiter.pl, koszt usługi to 50 zł brutto za każde 1000 adresów. Minimalna wartość zamówienia to 500 zł brutto. W celu zlecenia importu napisz na info@benefiter.pl
Jaki jest adres API Benefitera?
Adresem na który należy przesyłać odpowiednio spreparowane dane metodą GET jest:
http://www.benefiter.pl/api/get/
Jak działa to API?
Na chwilę obecną udostępniamy 3 podstawowe funkcje.
check - umożliwiającą sprawdzenie czy użytkownik jest na liście adresowej.
add - umożliwiającą dodanie adresu email na listę adresową.
remove - usuwającą adres email z listy adresowej.
Działania na przykładach:
Sprawdzamy występowanie adresu email na liście mailingowej.
Załóżmy, że chciałbyś sprawdzić czy wybrany adres email jest już wpisany na liście adresowej. W tym celu należy wykonać komendę.
http://www.benefiter.pl/api/get/?action=check&email=mojadres@email.pl&aid=1234&key=hj32236j412dsag
Jak widzisz przesłaliśmy na adres skryptu kilka istotnych danych.
Po pierwsze zmienna action. Tutaj należy wprowadzić jedną ze wspomnianych funkcji API. W tym wypadku jest co check za pomocą której sprwadzamy występowanie adresu w bazie. Kolejna zmienna to email - tutaj wprowadzamy sprawdzany adres email. Kolejna zmienna to aid która oznacza "autoresponder id" czyli w skrócie numer id autorespondera. Numer ID danego autorespondera (czy inaczej listy adresowej) znajdziesz w zakładce USTAWIENIA przy wybranej liście w swoim panelu na stronie: http://www.benefiter.pl/panel/autorespondery/
W tym samym miejscu znajdziesz również tzw. HASH API, który jest przypisanym ciągiem znaków stanowiącym hasło dostępu API dla tego autorespondera. Zmienną key tworzymy zapisując w ciągu md5 dwie wartości - sprawdzany adres email oraz HASH API. Przykładowo w php będzie to:
<?php
/* Generujemy hashapi Benefitera */
$key=md5($email.$hashapi);
?>
Wykonując tak spreparowany link, API Benefitera wyświetli nam rezultat. Np.:
OK:2:1306569741
Co oznacza:
OK czyli - email występuje na liście
2 - oznacza numer statusu. Znaczenie numerów to 2 = zapisany i potwierdzony 1 = zapisany ale niepotwierdzony 0 = zawieszony przez nas.
1306569741 to wartość unixowa dodania adresu email do listy.
W przypadku jakiegokolwiek błędu, Benefiter API poinformuje nas o tym bezpośrednio w wyniku zapytania.
Jak dodać nowy adres email poprzez API?
Rozwiązanie możemy skrócić do jednego zdania. Tak samo jak sprawdzamy z tą różnicą, że zamiast wartości check wprowadzamy add. Uwaga! poniższy link doda adres email odrazu z aktywacją. Dodawaj więc wyłącznie adresy użytkowników, którzy wyrazili na to wcześniej zgodę.
http://www.benefiter.pl/api/get/?action=add&email=mojadres@email.pl&aid=1234&key=hj32236j412dsag
Jak usuwamy użytkownika?
Tam samo jak dodajemy z tą różnicą, że zamiast add wprowadzamy remove czyli
http://www.benefiter.pl/api/get/?action=remove&email=mojadres@email.pl&aid=1234&key=hj32236j412dsag
Jak masowo dodać adresy email z naszego portalu?
Poniższe rozwiązanie napisano w PHP. Kod należy zapisać do pliku np. wgraj.php, następnie podmienić dane i uruchomić w przeglądarce.
<?php
$hashapi = "12dsasd654ff23dfdasdsag43sadas";
$aid = 1234;
$n1=mysql_query("SELECT email FROM users");
while($n2=mysql_fetch_array($n1)){
$key=md5($n2['email'].$hashapi);
@file_get_contents("http://www.benefiter.pl/api/get/?action=add&email=".$n2['email']."&aid=".$aid."&key=".$key);
echo $n2['email']." -> OK<br>";
$key=NULL;
}
?>
Uważasz, że ten artykuł był przydatny ? Oceń go!
