Difference between revisions of "Installing and configuring Offer Walls"

From TITAN Wiki
Jump to: navigation, search
m
(Tag: visualeditor)
m
(Tag: visualeditor)
Line 1: Line 1:
Titan is the first script to introduce global support to all Offer Walls and CPA/GPT Networks. After it's properly installed and configured, you can use any Offer Wall with no extra management. All postbacks (see [[Postbacks|''Postbacks'']]) are handled 100% automatically.
+
Titan is the first script to introduce global support to all [[Offer Walls]] and [[CPA/GPT Network|CPA/GPT Networks]]. After it's properly installed and configured, you can use any [[Offer Walls|Offer Wall]] with no extra management. All [[Postbacks|postbacks]] are handled 100% automatically.
  
We can't automatically add all Offer Walls ready-to-go to the script for one simple reason: every Offer Wall configuration is unique and it depends on the account you create in every Offer Wall provider. That is why we wrote tutorial how to integrate each Offer Wall provider into your Titan script.  
+
We can't automatically add all Offer Walls to the script for one simple reason: every Offer Wall configuration is unique and it depends on the account you create in every [[Offer Walls|Offer Wall]] provider. That is why we wrote tutorial how to integrate each Offer Wall provider into your Titan script.  
  
 
== Universal installation process ==
 
== Universal installation process ==
Yoy need to complete this process for every Offer Wall you want to install.  
+
Yoy need to complete this process for every [[Offer Walls|Offer Wall]] you want to install.  
  
==== Create new Offer Wall ====
+
=== Preparation ===
Go to ''Admin Panel / CPA/GPT / Offer Walls / Add new'' and click "Add new, empty Offer Wall" button. After you click the button, you should see a success message and be redirected to Installed Offerwalls within 10 seconds. You should now see your newly created Offer Wall as "Awaiting setup..". Activate it (see ''[[Offer Walls|Activating, pausing and deleting Offer Walls]]'').  
+
 
 +
==== Create new [[Offer Walls|Offer Wall]] ====
 +
Go to ''Admin Panel CPA/GPT Offer Walls Add new'' and click "Add new, empty Offer Wall" button. After you click the button, you should see a success message and get redirected to Installed Offerwalls page within 10 seconds. You should now see your newly created Offer Wall as "Awaiting setup..". [[Offer Walls|Activate]] it.  
  
 
==== Edit the Offer Wall ====
 
==== Edit the Offer Wall ====
In ''Admin Panel / CPA/GPT / Offer Walls / Installed Offerwall'' click "See details and edit" button. You will now see Offer Wall summary page. To edit its settings, click "Edit Offer Wall" in the panel to the left.   
+
In ''Admin Panel ''→'' CPA/GPT ''→'' Offer Walls ''→'' Installed Offerwall'' click "See details and edit" button. You will now see Offer Wall summary page. To edit its settings, click "Edit Offer Wall" in the panel to the left.   
  
 
==== Create the Offer Wall in the Offer Wall provider website ====
 
==== Create the Offer Wall in the Offer Wall provider website ====
Open a new tab. Go to your Offer Wall provider website and create an account there. Next log into your accout, and add new Offer Wall/application there. Fill in all details and save.  
+
Open a new tab. Go to your Offer Wall provider website and create an account there. Next log into your account, and add new Offer Wall/application. Fill in all details and save.  
  
==== Offer Wall HTML ====
+
=== Offer Wall HTML ===
 
Find your Offer Wall HTML on Offer Wall provider website and return to your Titan Admin Panel Offer Wall. Paste your Offer Wall HTML code into "HTML code" field. Make sure to replace current member username with '''[USERNAME]''' variable. Full list of supported variables can be found below:
 
Find your Offer Wall HTML on Offer Wall provider website and return to your Titan Admin Panel Offer Wall. Paste your Offer Wall HTML code into "HTML code" field. Make sure to replace current member username with '''[USERNAME]''' variable. Full list of supported variables can be found below:
 
{| class="wikitable"
 
{| class="wikitable"
Line 44: Line 46:
 
<sup>You can alternatively use %% instead of [], for example %USERNAME% will work the same as [USERNAME].</sup>
 
<sup>You can alternatively use %% instead of [], for example %USERNAME% will work the same as [USERNAME].</sup>
  
==== Postback variables ====
+
=== Postback ===
Go to your Offer Wall provider documentation and read postback documentation. Now return to your Titan Admin Panel and copy-paste all variables:
+
 
 +
==== [[Postbacks|Postback]] variables ====
 +
Go to your Offer Wall provider documentation and read [[Postbacks|postback]] documentation. Now return to your Titan Admin Panel and copy-paste all variables:
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 71: Line 75:
 
|No
 
|No
 
|}
 
|}
<sup>*Make sure that ''Tracking Info variable'' is unique for transaction and independent of its status (''Tracking Info variable'' should be the same for credit & reverse). It can be for example an Offer Id. It's needed for Points Locking (see [[Points Locking]]) feature to work.</sup>
+
<sup>*Make sure that ''Tracking Info variable'' is unique for transaction and independent of its status (''Tracking Info variable'' should be the same for credit & reverse). It can be for example an Offer Id. It's needed for [[Points Locking]] feature to work.</sup>
  
All variables support both: GET and POST. You can optionally (if required by Offer Wall provider) set "Successful response text". It's the text that will be returned if postback has been successful.
+
All variables support both: GET and POST. You can optionally (if required by Offer Wall provider) set "Successful response text". It is the text that will be returned if postback was successful.
  
==== Postback URL ====
+
==== [[Postbacks|Postback]] URL ====
 
Copy-paste your Postback URL from Titan Admin Panel to your Offer Wall provider website.
 
Copy-paste your Postback URL from Titan Admin Panel to your Offer Wall provider website.
  
==== Restrict Postback IPs (optional) ====
+
==== Restrict [[Postbacks|Postback]] IPs (optional) ====
 
For better security, it is recommended to restrict IP addresses that have access to your postback handler. Find IP addresses of your Offer Wall provider in their documentation (if there are any) and copy-paste them into "Whitelisted IPs" field. Make sure to check "Restrict Postback IPs" checkbox.  
 
For better security, it is recommended to restrict IP addresses that have access to your postback handler. Find IP addresses of your Offer Wall provider in their documentation (if there are any) and copy-paste them into "Whitelisted IPs" field. Make sure to check "Restrict Postback IPs" checkbox.  
 +
 +
=== Test and finish ===
  
 
==== Save settings ====
 
==== Save settings ====
Line 85: Line 91:
  
 
==== Test if your Offer Wall is displaying properly ====
 
==== Test if your Offer Wall is displaying properly ====
Go to your Titan Website - Menu - Earn - Offerwall and check if your Offer Wall is being displayed properly. Please note that some providers require approval before they will display their Offer Wall for you
+
Go to your Titan Website Menu Earn Offerwall and check if your Offer Wall is being displayed properly. Please note that some providers require approval before they allow displaying their [[Offer Walls|Offer Wall]].
  
 
==== Test Postback ====
 
==== Test Postback ====
Go to your Offer Wall provider website and find Test Postback feature. Enter example variables and click "Test":  
+
Go to your Offer Wall provider website and find test postback feature. Enter example variables and test:  
* Username: admin  
+
* Username: admin
 
* Amount: 10  
 
* Amount: 10  
Now return to your Titan Admin Panel and go to Postback Log (see [[Offer Walls|''Analyzing Postbacks'']]). If everything has been configured properly, you should see your test postback record with status "'''CreditedByOfferwall'''". Congratulations! Your Offer Wall has been installed, configured properly.   
+
Now return to your Titan Admin Panel and go to [[Offer Walls|''Postback Log'']]. If everything has been configured properly, you should see your test postback record with status "'''CreditedByOfferwall'''". Congratulations! Your [[Offer Walls|Offer Wall]] has been installed and configured properly.   
  
 
== Installing particular Offer Wall providers ==
 
== Installing particular Offer Wall providers ==
Line 99: Line 105:
 
See [[Installing and configuring SuperRewards Offer Wall|''Installing and configuring SuperRewards Offer Wall'']]
 
See [[Installing and configuring SuperRewards Offer Wall|''Installing and configuring SuperRewards Offer Wall'']]
  
==== More to come here :-) ====
+
==== Stay tunned, more to come.. ====

Revision as of 22:16, 19 May 2016

Titan is the first script to introduce global support to all Offer Walls and CPA/GPT Networks. After it's properly installed and configured, you can use any Offer Wall with no extra management. All postbacks are handled 100% automatically.

We can't automatically add all Offer Walls to the script for one simple reason: every Offer Wall configuration is unique and it depends on the account you create in every Offer Wall provider. That is why we wrote tutorial how to integrate each Offer Wall provider into your Titan script.

Universal installation process

Yoy need to complete this process for every Offer Wall you want to install.

Preparation

Create new Offer Wall

Go to Admin Panel → CPA/GPT → Offer Walls → Add new and click "Add new, empty Offer Wall" button. After you click the button, you should see a success message and get redirected to Installed Offerwalls page within 10 seconds. You should now see your newly created Offer Wall as "Awaiting setup..". Activate it.

Edit the Offer Wall

In Admin Panel CPA/GPT Offer Walls Installed Offerwall click "See details and edit" button. You will now see Offer Wall summary page. To edit its settings, click "Edit Offer Wall" in the panel to the left.

Create the Offer Wall in the Offer Wall provider website

Open a new tab. Go to your Offer Wall provider website and create an account there. Next log into your account, and add new Offer Wall/application. Fill in all details and save.

Offer Wall HTML

Find your Offer Wall HTML on Offer Wall provider website and return to your Titan Admin Panel Offer Wall. Paste your Offer Wall HTML code into "HTML code" field. Make sure to replace current member username with [USERNAME] variable. Full list of supported variables can be found below:

Variable Description Required
[USERNAME] Username of currently logged in member Yes
[REGISTERED] Registration date of the member (unix timestamp) No
[EMAIL] Email of the member No
[AGE] Age of the member No
[GENDER] Gender of the member ('M', 'F' or 'U' if unknown) No

You can alternatively use %% instead of [], for example %USERNAME% will work the same as [USERNAME].

Postback

Postback variables

Go to your Offer Wall provider documentation and read postback documentation. Now return to your Titan Admin Panel and copy-paste all variables:

Name Variable should contain: Required
Username variable Username of the member who completed the submission Yes
Points/money variable Virtual currency (Points) or its money equivalent that should be credited to the member Yes
Tracking Info variable Tracking ID of the submission* Yes
Credit type variable Information whether the postback credits or reverses the submission No
Signature variable Additional security feature. Contains secure signature that signs every postback submission No

*Make sure that Tracking Info variable is unique for transaction and independent of its status (Tracking Info variable should be the same for credit & reverse). It can be for example an Offer Id. It's needed for Points Locking feature to work.

All variables support both: GET and POST. You can optionally (if required by Offer Wall provider) set "Successful response text". It is the text that will be returned if postback was successful.

Postback URL

Copy-paste your Postback URL from Titan Admin Panel to your Offer Wall provider website.

Restrict Postback IPs (optional)

For better security, it is recommended to restrict IP addresses that have access to your postback handler. Find IP addresses of your Offer Wall provider in their documentation (if there are any) and copy-paste them into "Whitelisted IPs" field. Make sure to check "Restrict Postback IPs" checkbox.

Test and finish

Save settings

Save your settings on both: Offer Wall provider website and Titan Admin Panel.

Test if your Offer Wall is displaying properly

Go to your Titan Website → Menu → Earn → Offerwall and check if your Offer Wall is being displayed properly. Please note that some providers require approval before they allow displaying their Offer Wall.

Test Postback

Go to your Offer Wall provider website and find test postback feature. Enter example variables and test:

  • Username: admin
  • Amount: 10

Now return to your Titan Admin Panel and go to Postback Log. If everything has been configured properly, you should see your test postback record with status "CreditedByOfferwall". Congratulations! Your Offer Wall has been installed and configured properly.

Installing particular Offer Wall providers

Before you read this section, please first read Universal installation process above. You will basically have to complete this process for every provider listed below. It just differs on some points.

Super Rewards

See Installing and configuring SuperRewards Offer Wall

Stay tunned, more to come..