Developer docsicon Chevron Right Gray
Desktop integration docs

Desktop integration docs

Initial Setup

In your login, there is a self-guided process that guides you through setting up your offerwall placement. On the offerwall page, you enter the fields listed below:

Create Offer wall

From there, you are provided with your unique offerwall URLs.

Desktop Integration Options

1. Embedding

Once your postback is setup and tested, embed the iFrame code in on your website. If you choose this option, we highly recommend making the iFrame size responsive, or at least 1000 pixels high to ensure that users see enough offers when loading the offerwall initially.  If the embedded iFrame is too small, eCPMs and engagement may be lower.

2. Direct Linking

Once your postback is setup and tested, send your users to the Direct URL that includes their unique user ID in their browser. This ensures that all actions are tracked properly, and gives the user the option to leave the window open and continue to come back and earn virtual currency even when not in-game.

Postback Info

Offerwall Specific Postback Variables

Once your postback is setup and tested, embed the iFrame code in an in- game browser. If you choose this option, we highly recommend having offers open in the users regular browser and not in the in-app browser to ensure that tracking is accurate.

  • $uid$: The user’s unique identifier, which you will give to us when loading the IFRAME
  • $currency$: The amount of virtual currency issued. This may be a negative number, indicating a currency revocation (if you opt to pass these along).
  • $country$: Country code where the conversion occured, ISO 3166-1 alpha-2 format.
  • $clicktimestamp$: Time of click sent as a UNIX timestamp (UTC).
  • $currencytype$: May be one of the following values:
    1 – Offer completed
    2 – Currency issued by customer service
    3 – Offer reversed (currency revocation – currency will have a negative value)
  • $offertype$: May be one of the following values:
    0 – Undefined
    1 – Free
    2 – Purchase
    3 – Trial
    4 – Other
    5 – Mobile Apps
    6 – Clicks and Videos
    7 – Studies
    8 – Contest

Additional Postback Variables

  • $campaign$: The campaign ID number of the offer being posted.
  • $name$: The name of the offer being posted.
  • $rate$: The commission earned (i.e, 5.75). If the offer is being reversed, this will be a negative number (i.e, -5.75).
  • $sid$: The SID that you passed to the campaign.
  • $sid3$: Additional SID parameter #3.
  • $sid4$: Additional SID parameter #4.
  • $status$: This will be either 1 or 2, for completed or reversed, respectively.
  • $actionid$: The network action ID for this lead.
  • $ip$: The IP address recorded when the user clicked the offer.
  • $timestamp$: UNIX timestamp (UTC) of the conversion.
  • $country$: Country code of user, ISO 3166-1 alpha-2 format.
  • $clicktimestamp$: UNIX timestamp (UTC) of the click.

Postback Security

All posts may originate from one of the following IP addresses:

  • IPv6: 2604:e880:2::/64
  • IPv6: 2604:a880:400:d0::/64

Please configure your postback to only accept posts from these IPs.

Postback Rules

Our server must be able to connect in 4 seconds or less, and complete the post in 4 seconds or less, for a total of 8 seconds per post.  If a postback fails, we will attempt to complete the postback every 10 minutes no more than 6 times; our system will then delete that particular postback. If any postback fails, you will receive an e-mail when that occurs.

Please ensure your server only responds with HTTP Status Code “200 OK” if the postback is successful.  If we receive the response HTTP Status Code “200 OK” for a postback failure we will NOT be able to re-post the postback.

Testing Postback

In your portal in the “Configure Postbacks” section, there is an area to test postbacks without completing an offer to ensure your setup is working.  You will see the following display:

Testing Postback

Select the offerwall you’d like to test.  Then, ensure you enter the userID in the SID2/UID field.  The SID3 field is optional and not required, but may be used to pass back more information.  Enter the currency amount you’d like to award, and hit submit, and a postback will be submitted to your system so you can verify it is working properly.