Integration of AdvertWayCONTENT with your website

Inserting AdvertWayCONTENT on the page.

AdvertWayCONTENT should be placed on the page inside the form. So you should insert the following javascript code between the tags <form></form> Instead of [your-public-key], insert your site's public key. You will get the public key and the private key after adding your site in the publisher panel.

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

The property of AdvertWayCONTENT is that it displays only ads. If there are no ads to display, AdvertWayCONTENT is invisible on the page. In this case, you may also need to hide other elements of the website. The “onNoAds” event can be used for this purpose. You should assign your own function to this event:

awContent.onNoAds(function(){
  // body of method
});
  

It will be executed every time an ad is not displayed in AdvertWayCONTENT

Ajax

If you need to display AdvertWayCONTENT dynamically, you can use the AJAX API.

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

Then, to create and display the AdvertWayCONTENT, simply call the function 'getAjaxWidget()'.

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

It is necessary to pass your public key and the parameter 'div_id' to the function. This is the id of the element where you want AdvertWayCONTENT to appear.

With dynamic display, it is also possible to define a custom function that will be executed when there are no ads to display.

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

Note: Only one instance of AdvertWayCONTENT can be displayed on a single page.

Verification

To verify the correctness of the text from the advertisement entered by the user, follow these steps:

1. Send a POST request to http://api.advertway.pl/awcontent-validate.php with the following parameters:
   • public_key - Your site's public key
   • challenge_code - captcha identifier, it is located in the form field named avcontent_challenge_code
   • solution - captcha solution entered by the user, it is located in the form field named avcontent_solution
   • user_ip - user's IP address
2. In response, you will receive information about the verification carried out.
   The answer contains 3 fields, each on a separate line:
   • verification result - can take the value true or false. If the AWContent solution is correct it takes the value true, otherwise false.
   • error message - when the result field returned false, the msg field contains a short message describing the cause of the error
   • auth code - contains a code that can be used to verify that this response comes from our servers and is not fake
3. Optionally, you can verify the answer you receive to be sure that it is true and comes from us.
   . To do so:
   • Combine the values of the form fields avcontent_challenge_code, avcontent_solution and your site private key into a single string,
   • Then calculate the SHA1 digest for it,
   • so the resulting string compare with the value of the auth field from the response - they should be identical,
   • if the values differ, you should consider the user's AWContent solution incorrect

Example code in 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;
    }
  

Libraries and examples

In order to improve the process of integrating the AdvertWayCONTENT system with your website, you can use a library prepared by us for the PHP language - download

We have also prepared a sample PHP script showing the operation of the AdvertWay system with a simple form on the website - download