Integracja systemu AdvertWayCAPTCHA z Twoją stroną internetową

Wstawianie AdvertWayCAPTCHA na stronie

Na swojej stronie, pomiędzy tagami formularza (<form></form>) wstaw poniższy kod javascript. Zamiast [your-public-key], wstaw swój klucz publiczny witryny (zmiany należy dokonać w dwóch miejscach w kodzie). Klucz publiczny oraz prywatny uzyskasz po dodaniu swojej witrny w panelu wydawcy.

<script type="text/javascript" 
  src="http://api.advertway.pl/get.php?public_key=[your-public-key]"></script> 
<noscript> 
<iframe src="http://api.advertway.pl/getnoscript.php?public_key=[your-public-key]" 
  width="330" height="310" frameborder="0" style="margin: 0"></iframe> 
  <div>
    <label>Skopiuj kod captchy:</label> 
    <input type="text" name="captcha_challenge_code" />
  </div> 
  <div>
    <label>Wpisz kod z obrazka:</label> 
    <input type="text" name="captcha_solution" />
  </div> 
</noscript> 

Ajax

Jeżeli potrzebne jest wyświetlanie AdvertWayCAPTCHA dynamicznie, można użyć AJAX API.

<script type="text/javascript" 
  src="http://api.advertway.pl/ajax-get.php"></script>

Następnie, aby utworzyć i wyświetlić AdvertWayCAPTCHA wystarczy wywołać metodę 'getAjaxWidget()'.

awCaptcha.getAjaxWidget('your-public-key', 'div_id');

Konieczne jest przekazanie do funkcji swojego klucza publicznego oraz parametru 'div_id'. Jest to id elementu, gdzie ma się pojawić AdvertWayCAPTCHA.

Uwaga: Na jednej stronie może być wyświetlona tylko jedna instancja AdvertWayCAPTCHA.

Weryfikacja

Aby zweryfikować poprawność kodu wpisanego przez użytkownika należy wykonać następujące czynności:

1. Wysłać żądanie POST na adres http://api.advertway.pl/validate.php z następującymi parametrami:
   • public_key - Twój klucz publiczny witryny
   • challenge_code - identyfikator AdvertWayCAPTCHA, znajduje się on w polu formularza o nazwie captcha_challenge_code
   • solution - rozwiązanie AdvertWayCAPTCHA wpisane przez użytkownika, znajduje się ono w polu formularza o nazwie captcha_solution
   • user_ip - adres IP użytkownika
2. W odpowiedzi otrzymasz informacje o przeprowadzonej weryfikacji.
   Odpowiedź zawiera 3 pola, każde w osobnej lini:
   • rezultat weryfikacji - może przyjmować wartość true lub false. W przypadku, gdy rozwiązanie captchy jest prawidłowe przyjmuje wartość true, w innym przypadku false.
   • komunikat błędu - gdy pole result zwróciło wartość false, pole msg zawiera krótki komunikat opisujący przyczynę błędu
   • kod auth - zawiera kod, który może zostać użyty do zweryfikowania czy ta odpowiedź pochodzi z naszych serwerów i nie jest fałszywa
3. Opcjonalnie możesz zweryfikować otrzymaną odpowiedź, aby być pewnym, że jest ona prawdziwa i pochodzi od nas.
   Aby to zrobić:
   • połącz wartości pól formularza captcha_challenge_code, captcha_solution oraz Twój klucz prywatny witryny w jeden ciąg znaków,
   • następnie oblicz dla niego skrót SHA1,
   • tak powstały ciąg znaków porównaj z wartością pola auth z odpowiedzi - powinny być identyczne,
   • jeżeli wartości się różnią, powinieneś uznać rozwiązanie captchy przez użytkownika za nieprawidłowe

Przykładowy kod w PHP:

    function verifyResponse($response)
    {
      $privateKey = '[your-private-key]';
      list($rObj->result, $rObj->msg, $rObj->auth) = explode("\n", $response);
      $sha1Hash = sha1($rObj->result . $rObj->msg . $privateKey);
      return $sha1Hash === $rObj->auth ? true : false; 
    }
  

Biblioteki i przykłady

W celu usprawnienia procesu integracji systemu AdvertWayCAPTCHA ze swoją stroną internetową można wykorzystać przygotowaną przez nas bibliotekę dla języka PHP - pobierz

Przygotowaliśmy również przykładowy skrypt PHP przedstawiający działanie systemu AdvertWayCAPTCHA z prostym formularzem na stronie internetowej - pobierz

Wtyczka do Wordpress

Jeżeli korzystasz z platformy Wordpress, najprostszym sposobem integracji systemu AdvertWayCAPTCHA z Twoją stroną, będzie zainstalowanie naszej wtyczki - pobierz

Wtyczka ta pozwala na umieszczenie AdvertWayCAPTCHA w formularzu rejestracji oraz w sekcji komentarzy. Obsługuje również wtyczkę "Contact Form 7", co pozwala na umieszczenie captchy w formularzu kontaktowym.

Opis instalacji:

1. Pobierz wtyczkę
2. W menu Wtyczki w panelu Wordpress wybierz Wyślij na serwer. Podaj lokalizację pliku .zip z naszą wtyczką i wgraj ją na serwer. Ewentualnie wypakuj zawartość pliku i wgraj cały katalog "advertwayCaptcha" do katalogu "/wp-content/plugins/" Twojego Wordpressa.
3. Aktywuj wtyczkę poprzez menu "Wtyczki" w Wordpress.
4. Zarejestruj się na http://publisher.advertway.pl, dodaj witrynę do systemu AdvertWayCAPTCHA. Uzyskane klucze (publiczny i prywatny), skopiuj i wklej w formularzu ustawień AdvertWayCAPTCHA w Wordpress. Znajduje się on w menu "Ustawienia", gdzie możesz także zdefiniować gdzie ma być umieszczona captcha.

Uwaga: Aby włączyć AdvertWayCAPTCHA w formularzu kontaktowym "Contact Form 7" należy w ustawieniach pola 'Formularz' dodać [awcaptcha awcaptcha-1] ponad wierszem [submit "Wyślij"].

Wtyczka do phpBB

Jeżeli prowadzisz forum oparte o aplikację phpBB 3, najprostszym sposobem integracji systemu AdvertWayCAPTCHA z Twoim forum, będzie zainstalowanie naszej wtyczki - pobierz

Instalacja:

1. Pobierz wtyczkę
2. Wypakuj zawartość pobranego pliku.
3. Postępuj zgodnie z instrukcjami zawartymi w pliku install3.0.9.xml

Wtyczka do IP.Board 3

Jeżeli prowadzisz forum oparte o aplikację IP.Board 3, najprostszym sposobem integracji systemu AdvertWayCAPTCHA z Twoim forum, będzie zainstalowanie naszej wtyczki - pobierz

Instalacja:

1. Pobierz wtyczkę
2. Wypakuj zawartość pobranego pliku.
3. Postępuj zgodnie z instrukcjami zawartymi w pliku install.html