Documentation

Getting Started

Welcome to the CryptoAd documentation. Bellow you will find all required informations to integrate our offerwall into your website in just few minutes.

Before integrating our offerwall, make sure you're registered on our website, account is required to use any of our tools.

Add your Website

To be able to integrate our offerwall, first you have to add your website. Once you have added your website you will have an API KEY and a SECRET KEY, that you will need to integrate our offerwall.

To register your website into our service, please follow these steps:

  1. Login to your CryptoAd account.
  2. You should now see the Add Website button at sidebar. Click this button to add your first website.
  3. Set your Website Name, Domain Name and application type (platform) and proceed to next step.
  4. Set your Currency Name in plural form (e.g. Points, Tokens, Coins...), Currency Round (the number of decimals your currency can have, up to 2 decimals) and Exchange Rate (how many of your website currency units will a user earn for every 1 USD that we will pay you).
  5. Set your Postback URL. Whenever a user completes an offer, we will make a call to this URL by sending all the information needed to help you to credit the virtual currency to your users.
  6. Done! You have add your website, one of our team members will review it and once it is approved you will receive an email in the meantime you can continue with the integration process. You will find more informatons about postback integration in next chapters of this documentation.

Integrate Offerwall

Our Offerwall enables users to benefit from incentives and rewards thanks to segmented, automatically translated ads. Our offerwall will adapt to any screen and will show offers to your users.

Before being able to integrate our offerwall, you must register your website first. Once you have registered your website you will have an API KEY and a SECRET KEY, that you will need in the following steps.

  1. Click on My Websites button on sidebar.
  2. From your websites list, you can get your API and Secret keys, anyway if you click Edit button on any of your websites you will be able to get your full integration code of the offerwall.


    From your website overview, you can get the offerwall code by clicking on Get Offerwall Code button. You just need to copy the code on your website.

Offerwall Code

<iframe style="width:100%;height:800px;border:0;padding:0;margin:0;" scrolling="yes" 
frameborder="0" src="https://cryptoad.org/offerwall/[API_KEY]/[USER_ID]"></iframe>

Replace [API_KEY] with your website api key and [USER_ID] by the unique identifier code of the user of your site who is viewing the wall.

Parameter Description Value
[API_KEY] Unique API Code provided when you registered your website varchar(32)
[USER_ID] Unique identifier code of the user of your site varchar(32)

Postback Notifications

Whenever a user complete an offer, we will make a call to the Postback URL that you indicated in your app attaching all the information that you will need to credit your users.

Our server will make a HTTP POST request to your server including all of the following parameters.

Parameter Description Example
subId This is the unique identifier code of the user who completed action on your platform. user123
transId Unique identification code of the transaction made by your user. XX-12345678
reward The amount of your virtual currency to be credited to your user. 1.25
reward_name The name of your currency set when you registered your website. Points
payout The offer payout in USD 0.100000
userIp The user's IP address who completed the action. 192.168.1.0
country Country (ISO2 form) from the lead comes. US
status Determines whether to add or subtract the amount of the reward. "1" is when the virtual currency should be added to the user and "2" when it should be subtracted. This may be because the advertiser has canceled the user's transaction, either because he/she committed fraud or because it has been a mistake entering the data needed to complete the campaign. 1 (valid) / 2 (chargeback)
debug Check if is a test or a live postback call. 1 (test) / 0 (live)
signature MD5 hash that can be used to verify that the call has been made from our servers. 17b4e2a70d6efe9796dd4c5507a9f9ab

"reward" and "payout" parameters are always absolute values, you will need to check status parameter to see if you need to add or subtract that amount from your users.

Postback Security

You should verify the signature received in the postback to ensure that the call comes from our servers.
Signature parameter should match MD5 of subId transactionId reward secret key. You can find your Secret Key of your website in My Websites section.

The formula to be checked is as follows:

<?php
  $secret = ""; // Get your secret key from CryptoAd

  $subId = isset($_REQUEST['subId']) ? $_REQUEST['subId'] : null;
  $transId = isset($_REQUEST['transId']) ? $_REQUEST['transId'] : null;
  $reward = isset($_REQUEST['reward']) ? $_REQUEST['reward'] : null;
  $signature = isset($_REQUEST['signature']) ? $_REQUEST['signature'] : null;

  // Validate Signature
  if(md5($subId.$transId.$reward.$secret) != $signature)
  {
   echo "ERROR: Signature doesn't match";
   return;
  }
?>

Our servers wait for a response for a maximum time of 60 seconds before the timeout. In this case, postback will be marked as failed. Please, check if the transaction ID sent to you was already entered in your database, this will prevent to give twice the same amount of virtual currency to the user.

IPs to whitelist

We will be sending the postbacks from any of the following IP addresses. Please make sure they are whitelisted if needed to be in your server.

68.65.123.107

Respond to Postback

Our servers will expect your website to respond with "ok". If your postback doesn't return "ok" as response, postback will be marked as failed (even if postback was successfully called) and you will be able to resend it manually from our website.

Postback Example

The following example is not a working one but should be enough to understand how you should implement your postback in your website.

<?php
  $secret = ""; // Get your secret key from CryptoAd

  // Proceess only requests from CryptoAd IP addresses
  $allowed_ips = array(68.65.123.107);
  if(isset($_SERVER['HTTP_X_FORWARDED_FOR']))
  {
   $IP = $_SERVER['HTTP_X_FORWARDED_FOR']; 
  }
  else 
  { 
   $IP = $_SERVER['REMOTE_ADDR'];
  }

  if(!in_array($IP, $allowed_ips)) 
  {
   echo "ERROR: Invalid source";
   return;
  }

  // Get postback variables
  $userId = isset($_REQUEST['subId']) ? $_REQUEST['subId'] : null;
  $transId = isset($_REQUEST['transId']) ? $_REQUEST['transId'] : null;
  $reward = isset($_REQUEST['reward']) ? $_REQUEST['reward'] : null;
  $reward_name = isset($_REQUEST['reward_name']) ? $_REQUEST['reward_name'] : null;
  $payout = isset($_REQUEST['payout']) ? $_REQUEST['payout'] : null;
  $ipuser = isset($_REQUEST['userIp']) ? $_REQUEST['userIp'] : "0.0.0.0";
  $country = isset($_REQUEST['country']) ? $_REQUEST['country'] : null;
  $status = isset($_REQUEST['status']) ? $_REQUEST['status'] : null;
  $debug = isset($_REQUEST['debug']) ? $_REQUEST['debug'] : null;
  $signature = isset($_REQUEST['signature']) ? $_REQUEST['signature'] : null;

  // Validate signature
  if(md5($userId.$transId.$reward.$secret) != $signature)
  {
    echo "ERROR: Signature doesn't match";
    return;
  }

  // Add or substract the reward
  if($status == 2)
  {
    //  2 = Chargeback, substract reward from user
    $reward = -abs($reward);
  }

   // Check if the transaction is new, use $transId to valiate it
  if(isNewTransaction($transId))
  { 
    // Transaction is new, reward your user
    processTransaction($userId, $reward, $transId);
  }
  else
  {
    // This transaction already exist
  }

  echo "ok"; // Important!
?>

Intregrate Offerwall on Best Faucet Scripts

We have provide you some Best Faucet scripts intregartion method here,with this tutorial any faucet owner can easyly intregrate on there script

Vie Faucet 4.3 Integration

This version runs on USD!

It takes only three steps to integrate CryptoAd offerwall into your VieFaucet script.Please find below steps.

First open file - application/controllers/wh.php and enter the following code before last closing bracket (}).

💡 Do not forget to enter your secret key under variable $secret from the CryptoAd's dashboard. Otherwise,your users will not be credited properly since postback will not work.


         public function CryptoAd()
	  {
             $secret = ""; // UPDATE YOUR SECRET KEY
             $hold = 3;  // UPDATE HOLD DAYS IF YOU USE HOLD
             $minHold= 0.5; // Reward Lower than this amount will not be hold
            
             $userId = isset($_REQUEST['subId']) ? $this->db->escape_str($_REQUEST['subId']) : null;
             $transactionId = isset($_REQUEST['transId']) ? $this->db->escape_str($_REQUEST['transId']) : null;
             $reward = isset($_REQUEST['reward']) ? $this->db->escape_str($_REQUEST['reward']) : null;
             $action = isset($_REQUEST['status']) ? $this->db->escape_str($_REQUEST['status']) : null;
             $userIp = isset($_REQUEST['userIp']) ? $this->db->escape_str($_REQUEST['userIp']) : "0.0.0.0";
             $signature = isset($_REQUEST['signature']) ? $this->db->escape_str($_REQUEST['signature']) : null;
             if (md5($userId . $transactionId . $reward . $secret) != $signature) {
             echo "ERROR: Signature doesn't match";
             return;
             }
            
             $trans = $this->m_offerwall->getTransaction($transactionId, 'CryptoAd');
             if ($action == 2) {
             $this->m_offerwall->reduceUserBalance($userId, abs($reward));
             $this->m_offerwall->insertTransaction($userId, 'CryptoAd', $userIp, $reward, $transactionId, 1, time());
             echo "ok";
             } else {
		     if (!$trans) {
		     $hold = 0;
		     if ($reward > $minHold) {
		         $hold = 3; // UPDATE HOLD DAYS Which you Use for hold
		     	}
		    
		     if ($hold == 0) {
		     $offerId = $this->m_offerwall->insertTransaction($userId, 'CryptoAd', $userIp, $reward, $transactionId, 2, time());
		     $this->m_offerwall->updateUserBalance($userId, $reward);
		     $this->m_core->addNotification($userId, currency($reward, $this->data['settings']['currency_rate']) . " from CryptoAd Offer #" . $offerId . " was credited to your balance.", 1);
            
		     $user = $this->m_core->get_user_from_id($userId);
		     $this->m_core->addExp($user['id'], $this->data['settings']['offerwall_exp_reward']);
		     if (($user['exp'] + $this->data['settings']['offerwall_exp_reward']) >= ($user['level'] + 1) * 100) {
		     $this->m_core->levelUp($user['id']);
		     }
		     } else {
		     $availableAt = time() + $hold * 86400;
		     $offerId = $this->m_offerwall->insertTransaction($userId, 'CryptoAd', $userIp, $reward, $transactionId, 0, $availableAt);
		     $this->m_core->addNotification($userId, "Your CryptoAd Offer #" . $offerId . " is pending approval.", 0);
		     }
		     echo "ok";
		     } else {
		     echo "DUP";
		     }
	       }
        }

Second step is to add our offerwall in the UI. Inside application/controllers/offerwall.php file, add this code before last closing bracket (}).

💡 Don't forget to place on proper place your API key from the dashboard under $api_key variable. 


            public function CryptoAd()
	  {
		  $api_key=""; // UPDATE YOUR API KEY HERE
		 $this->data['page'] = 'CryptoAd Offerwall';
		 $this->data['iframe'] = '<iframe style="width:100%;height:800px;border:0;padding:0;margin:0;" scrolling="yes" frameborder="0" src="https://cryptoad.org/offerwall/' . $api_key . '/' . $this->data['user']['id'] . '"></iframe>';
		 $this->data['wait'] = 3; // UPDATE YOUR HOLD TIME
		 $this->render('offerwall', $this->data);
	 }

Third step is to add CryptoAd's offerwall inside your sidebar/ UserPanel Menu on Vie Faucet.

Go to this file application/views/user_template/template.php, and place this code above or under some of the existing offerwalls list.


    <li><a href="<?= site_url('offerwall/CryptoAd') ?>" key="t-CryptoAd">CryptoAd</a></li>

Final Step You must Add below code on your config files

Open Application/Config/config.php

Goto $config['csrf_exclude_uris'] this line

Add this code 'wh/CryptoAd', on that line.

How to set site on CryptoAd?

PostBack URL Should be : https://yourdomain.com/wh/CryptoAd

Vie Faucet 4.4 Integration

This version runs on Tokens!

It takes only three steps to integrate CryptoAd offerwall into your VieFaucet script.Please find below steps.

First open file - application/controllers/wh.php and enter the following code before last closing bracket (}).

💡 Do not forget to enter your secret key under variable $secret from the CryptoAd's dashboard. Otherwise,your users will not be credited properly since postback will not work.


         public function CryptoAd()
	  {
             $secret = ""; // UPDATE YOUR SECRET KEY
             $hold = 3;  // UPDATE HOLD DAYS IF YOU USE HOLD
             $minHold= 0.5; // Reward Lower than this amount will not be hold
            
             $userId = isset($_REQUEST['subId']) ? $this->db->escape_str($_REQUEST['subId']) : null;
             $transactionId = isset($_REQUEST['transId']) ? $this->db->escape_str($_REQUEST['transId']) : null;
             $reward = isset($_REQUEST['reward']) ? $this->db->escape_str($_REQUEST['reward']) : null;
             $action = isset($_REQUEST['status']) ? $this->db->escape_str($_REQUEST['status']) : null;
             $userIp = isset($_REQUEST['userIp']) ? $this->db->escape_str($_REQUEST['userIp']) : "0.0.0.0";
             $signature = isset($_REQUEST['signature']) ? $this->db->escape_str($_REQUEST['signature']) : null;
             if (md5($userId . $transactionId . $reward . $secret) != $signature) {
             echo "ERROR: Signature doesn't match";
             return;
             }
            
             $reward = $reward * $this->data['settings']['currency_rate'];
            
             $trans = $this->m_offerwall->getTransaction($transactionId, 'CryptoAd');
             if ($action == 2) {
             $this->m_offerwall->reduceUserBalance($userId, abs($reward));
             $this->m_offerwall->insertTransaction($userId, 'CryptoAd', $userIp, $reward, $transactionId, 1, time());
             echo "ok";
             } else {
		     if (!$trans) {
		     $hold = 0;
		     if ($reward > $minHold) {
		         $hold = 3; // UPDATE HOLD DAYS Which you Use for hold
		     	}
		    
		     if ($hold == 0) {
		     $offerId = $this->m_offerwall->insertTransaction($userId, 'CryptoAd', $userIp, $reward, $transactionId, 2, time());
		     $this->m_offerwall->updateUserBalance($userId, $reward);
		     $this->m_core->addNotification($userId, currencyDisplay($reward, $this->data['settings']) . " from CryptoAd Offer #" . $offerId . " was credited to your balance.", 1);
            
		     $user = $this->m_core->getUserFromId($userId);
		     $this->m_core->addExp($user['id'], $this->data['settings']['offerwall_exp_reward']);
		     if (($user['exp'] + $this->data['settings']['offerwall_exp_reward']) >= ($user['level'] + 1) * 100) {
		     $this->m_core->levelUp($user['id']);
		     }
		     } else {
		     $availableAt = time() + $hold * 86400;
		     $offerId = $this->m_offerwall->insertTransaction($userId, 'CryptoAd', $userIp, $reward, $transactionId, 0, $availableAt);
		     $this->m_core->addNotification($userId, "Your CryptoAd Offer #" . $offerId . " is pending approval.", 0);
		     }
		     echo "ok";
		     } else {
		     echo "DUP";
		     }
	       }
        }

Second step is to add our offerwall in the UI. Inside application/controllers/offerwall.php file, add this code before last closing bracket (}).

💡 Don't forget to place on proper place your API key from the dashboard under $api_key variable. 


            public function CryptoAd()
	  {
		  $api_key=""; // UPDATE YOUR API KEY HERE
		 $this->data['page'] = 'CryptoAd Offerwall';
		 $this->data['iframe'] = '<iframe style="width:100%;height:800px;border:0;padding:0;margin:0;" scrolling="yes" frameborder="0" src="https://cryptoad.org/offerwall/' . $api_key . '/' . $this->data['user']['id'] . '"></iframe>';
		 $this->data['wait'] = 3; // UPDATE YOUR HOLD TIME
		 $this->render('offerwall', $this->data);
	 }

Third step is to add CryptoAd's offerwall inside your sidebar/ UserPanel Menu on Vie Faucet.

Go to this file application/views/user_template/template.php, and place this code above or under some of the existing offerwalls list.


    <li><a href="<?= site_url('offerwall/CryptoAd') ?>" key="t-CryptoAd">CryptoAd</a></li>

Final Step You must Add below code on your config files

Open Application/Config/config.php

Goto $config['csrf_exclude_uris'] this line

Add this code 'wh/CryptoAd', on that line.

How to set site on CryptoAd?

PostBack URL Should be : https://yourdomain.com/wh/CryptoAd

CryptoFaucet/ClaimBits Integration

ClaimBits/CryptoFaucet is a Very populer of Crypto Faucet which brings plenty of different features together into a complete system.

CryptoAd integration is very easy in this script - Just need to create 1 file, Modify 2 line of code, and that’s it! Less than 5 minutes and you can bring CryptoAd offerwall to your users.

To create Postback file - open system/gateways/ and create file CryptoAd.php, put following code in this file:

                  
       <?php
        define('BASEPATH', true);
        require('../init.php');
        $secret = "YOUR SECRET KEY"; //Enter Your CryptoAd SECRET KEY
        
        $userId = isset($_REQUEST['subId']) ? $db->EscapeString($_REQUEST['subId']) : null;
        $survey = isset($_REQUEST['transId']) ? $db->EscapeString($_REQUEST['transId']) : null;
        $reward = isset($_REQUEST['reward']) ? $db->EscapeString($_REQUEST['reward']) : null;
        $payout = isset($_REQUEST['payout']) ? $db->EscapeString($_REQUEST['payout']) : null;
        $action = isset($_REQUEST['status']) ? $db->EscapeString($_REQUEST['status']) : null;
        $userIP = isset($_REQUEST['userIp']) ? $db->EscapeString($_REQUEST['userIp']) : '0.0.0.0';
        $country = isset($_REQUEST['country']) ? $db->EscapeString($_REQUEST['country']) : null;
        
        if (md5($userId.$survey.$reward.$secret) != $_REQUEST['signature']){
        echo "ERROR: Signature doesn't match";
        return;
        }
        if(!empty($userId) && $db->QueryGetNumRows("SELECT * FROM `completed_offers` WHERE `survey_id`='".$survey."' LIMIT 1") == 0)
        {
        $user = $db->QueryFetchArray("SELECT `id` FROM `users` WHERE `id`='".$userId."'");
        if(!empty($user['id'])) {
        $tc_points = (0.10*($payout*100));
        $tc_points = ($tc_points < 1 ? 1 : number_format($tc_points, 0));
        $db->Query("UPDATE `users` SET `ow_credits`=`ow_credits`+'".$reward."', `tasks_contest`=`tasks_contest`+'".$tc_points."' WHERE `id`='".$user['id']."'"); 
        $db->Query("INSERT INTO `users_offers` (`uid`,`total_offers`,`total_revenue`,`last_offer`) VALUES ('".$user['id']."','1','".$reward."','".time()."') ON DUPLICATE KEY UPDATE `total_offers`=`total_offers`+'1', `total_revenue`=`total_revenue`+'".$reward."', `last_offer`='".time()."'");
        $db->Query("INSERT INTO `completed_offers` (`user_id`,`survey_id`,`user_country`,`user_ip`,`revenue`,`reward`,`method`,`timestamp`) VALUES ('".$user['id']."','".$survey."','".$country."','".ip2long($userIP)."','".$payout."','".$reward."','CryptoAd','".time()."')");
        }
     }  
        echo 'ok';
       
       ?>

HOLA...Your, postback created Suceesfully! Now is time for iframe integration

Just Open template/default/pages/offers.php, and add the following code after some of the existing offerwalls. break; code.

    
           case 'CryptoAd' :
           $title = 'CryptoAd';
           $offer_wall = '<iframe src="https://cryptoad.org/offerwall/YOUR API KEY/'.$data['id'].'" style="width:100%;height:690px;border:0;border-radius:5px;"></iframe>';
            break;

.Replace YOUR API KEY by your CryptoAd API key from CryptoAd Website setting.

Scroll down and insert link to CryptoAd offerwall:

            
                 <a href="<?php echo GenerateURL('offers&x=CryptoAd'); ?>" class="btn btn-secondary mb-1<?php echo ($method == 'CryptoAd' ? ' active' : ''); ?>">CryptoAd</a>

And save, that is all!

How to set site on CryptoAd?

Note: Currency should be set in credits

Postback URL should be : http://yourdomain.com/system/gateways/CryptoAd.php

AutoFaucetScript - Ultimate Auto Faucet By NGB Solutions Integration

AutoFaucetScript is a Very populer of New Mordern AutoFaucet Script which brings plenty of different features together into a complete system.

CryptoAd integration is very easy in this script - Just need to create 1 file, Modify 2 line of code, and that’s it! Less than 5 minutes and you can bring CryptoAd offerwall to your users.

To create Postback file - open system/gateways/ and create file CryptoAd.php, put following code in this file:

                  
       <?php
        define('BASEPATH', true);
        require('../init.php');
        $secret = "YOUR SECRET KEY"; //Enter Your CryptoAd SECRET KEY
        
        $userId = isset($_REQUEST['subId']) ? $db->EscapeString($_REQUEST['subId']) : null;
        $survey = isset($_REQUEST['transId']) ? $db->EscapeString($_REQUEST['transId']) : null;
        $reward = isset($_REQUEST['reward']) ? $db->EscapeString($_REQUEST['reward']) : null;
        $payout = isset($_REQUEST['payout']) ? $db->EscapeString($_REQUEST['payout']) : null;
        $action = isset($_REQUEST['status']) ? $db->EscapeString($_REQUEST['status']) : null;
        $userIP = isset($_REQUEST['userIp']) ? $db->EscapeString($_REQUEST['userIp']) : '0.0.0.0';
        $country = isset($_REQUEST['country']) ? $db->EscapeString($_REQUEST['country']) : null;
        
        if (md5($userId.$survey.$reward.$secret) != $_REQUEST['signature']){
        echo "ERROR: Signature doesn't match";
        return;
        }
        if(!empty($userId) && $db->QueryGetNumRows("SELECT * FROM `completed_offers` WHERE `survey_id`='".$survey."' LIMIT 1") == 0)
        {
        $user = $db->QueryFetchArray("SELECT `id` FROM `users` WHERE `id`='".$userId."'");
        if(!empty($user['id'])) {
        $currentPrice = $db->QueryFetchArray("SELECT `value` FROM `bitcoin_price` ORDER BY `time` DESC LIMIT 1");
        $usdPayout = $currentPrice['value']*$payout;
        $tc_points = (0.10*$usdPayout);
        $tc_points = ($tc_points < 1 ? 1 : number_format($tc_points, 0));
        $db->Query("UPDATE `users` SET `ow_credits`=`ow_credits`+'".$reward."', `tasks_contest`=`tasks_contest`+'".$tc_points."' WHERE `id`='".$user['id']."'"); 
        $db->Query("INSERT INTO `users_offers` (`uid`,`total_offers`,`total_revenue`,`last_offer`) VALUES ('".$user['id']."','1','".$reward."','".time()."') ON DUPLICATE KEY UPDATE `total_offers`=`total_offers`+'1', `total_revenue`=`total_revenue`+'".$reward."', `last_offer`='".time()."'");
        $db->Query("INSERT INTO `completed_offers` (`user_id`,`survey_id`,`user_country`,`user_ip`,`revenue`,`reward`,`method`,`timestamp`) VALUES ('".$user['id']."','".$survey."','".$country."','".ip2long($userIP)."','".$usdPayout."','".$reward."','CryptoAd','".time()."')");
        }
     }  
        echo 'ok';
       
       ?>

HOLA...Your, postback created Suceesfully! Now is time for iframe integration

Just Open template/default/pages/offers.php, and add the following code after some of the existing offerwalls. break; code.

    
           case 'CryptoAd' :
           $title = 'CryptoAd';
           $offer_wall = '<iframe src="https://cryptoad.org/offerwall/YOUR API KEY/'.$data['id'].'" style="width:100%;height:690px;border:0;border-radius:5px;"></iframe>';
            break;

💡.Replace YOUR API KEY by your CryptoAd API key from CryptoAd Website setting.

Scroll down and insert link to CryptoAd offerwall:

            
                 <a href="<?php echo GenerateURL('offers&x=CryptoAd'); ?>" class="btn btn-secondary mb-1<?php echo ($method == 'CryptoAd' ? ' active' : ''); ?>">CryptoAd</a>

And save, that is all!

How to set site on CryptoAd?

Note: Currency should be set in credits

Postback URL should be : http://yourdomain.com/system/gateways/CryptoAd.php