Integracja systemu AdvertWayCONTENT z Twoją stroną internetową

Wstawianie AdvertWayCONTENT na stronie

AdvertWayCONTENT powinno być umieszczone na stronie wewnątrz formularza. Należy więc wstawić poniższy kod javascript pomiędzy tagami <form></form> Zamiast [your-public-key], wstaw swój klucz publiczny witryny. Klucz publiczny oraz prywatny uzyskasz po dodaniu swojej witrny w panelu wydawcy.

<script type="text/javascript" 
  src="http://api.advertway.pl/awcontent-get.php?public_key=[your-public-key]">
</script> 

Właściwością AdvertWayCONTENT jest to, że wyświetla tylko i wyłacznie reklamy. W przypadku braku reklam do wyświetlenia, AdvertWayCONTENT jest niewidoczny na stronie. W takim przypadku może być potrzebne również ukrycie innych elementów strony internetowej. Wykorzystać można w tym celu zdarzenie "onNoAds". Należy przypisać do tego zdarzenia własną funkcję:

awContent.onNoAds(function(){
  // zawartość funkcji
});
  

Będzie ona wykonywana za każdym razem, gdy nie będzie wyświetlana reklama w AdvertWayCONTENT

Ajax

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

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

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

awContent.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ć AdvertWayCONTENT.

Przy dynamicznym wyświetlaniu, również jest możliwe zdefiniowanie własnej funkcji, która będzie wykonywana w przypadku braku reklam do wyświetlenia.

awContent.onNoAds(function(){
  // zawartość funkcji
});

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

Weryfikacja

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

1. Wysłać żądanie POST na adres http://api.advertway.pl/awcontent-validate.php z następującymi parametrami:
   • public_key - Twój klucz publiczny witryny
   • challenge_code - identyfikator captchy, znajduje się on w polu formularza o nazwie awcontent_challenge_code
   • solution - rozwiązanie captchy wpisane przez użytkownika, znajduje się ono w polu formularza o nazwie awcontent_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 AWContent 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 awcontent_challenge_code, awcontent_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 AWContent 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 AdvertWayCONTENT 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 AdvertWay z prostym formularzem na stronie internetowej - pobierz